Created
April 30, 2015 10:45
-
-
Save cmatskas/14f8b052c59be9182ddd to your computer and use it in GitHub Desktop.
Swagger documentation output
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
swagger: "2.0", | |
info: { | |
version: "v1", | |
title: "SwaggerTest" | |
}, | |
host: "localhost:63171", | |
schemes: [ | |
"http" | |
], | |
paths: { | |
/api/Account/UserInfo: { | |
get: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_GetUserInfo", | |
consumes: [ | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/UserInfoViewModel" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/Logout: { | |
post: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_Logout", | |
consumes: [ | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/ManageInfo: { | |
get: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_GetManageInfo", | |
consumes: [ | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "returnUrl", | |
in: "query", | |
required: true, | |
type: "string" | |
}, | |
{ | |
name: "generateState", | |
in: "query", | |
required: false, | |
type: "boolean" | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/ManageInfoViewModel" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/ChangePassword: { | |
post: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_ChangePassword", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "model", | |
in: "body", | |
required: true, | |
schema: { | |
$ref: "#/definitions/ChangePasswordBindingModel" | |
} | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/SetPassword: { | |
post: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_SetPassword", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "model", | |
in: "body", | |
required: true, | |
schema: { | |
$ref: "#/definitions/SetPasswordBindingModel" | |
} | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/AddExternalLogin: { | |
post: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_AddExternalLogin", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "model", | |
in: "body", | |
required: true, | |
schema: { | |
$ref: "#/definitions/AddExternalLoginBindingModel" | |
} | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/RemoveLogin: { | |
post: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_RemoveLogin", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "model", | |
in: "body", | |
required: true, | |
schema: { | |
$ref: "#/definitions/RemoveLoginBindingModel" | |
} | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/ExternalLogin: { | |
get: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_GetExternalLogin", | |
consumes: [ | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "provider", | |
in: "query", | |
required: true, | |
type: "string" | |
}, | |
{ | |
name: "error", | |
in: "query", | |
required: false, | |
type: "string" | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/ExternalLogins: { | |
get: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_GetExternalLogins", | |
consumes: [ | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "returnUrl", | |
in: "query", | |
required: true, | |
type: "string" | |
}, | |
{ | |
name: "generateState", | |
in: "query", | |
required: false, | |
type: "boolean" | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
type: "array", | |
items: { | |
$ref: "#/definitions/ExternalLoginViewModel" | |
} | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/Register: { | |
post: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_Register", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "model", | |
in: "body", | |
required: true, | |
schema: { | |
$ref: "#/definitions/RegisterBindingModel" | |
} | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Account/RegisterExternal: { | |
post: { | |
tags: [ | |
"Account" | |
], | |
operationId: "Account_RegisterExternal", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "model", | |
in: "body", | |
required: true, | |
schema: { | |
$ref: "#/definitions/RegisterExternalBindingModel" | |
} | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
$ref: "#/definitions/Object" | |
} | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Values: { | |
get: { | |
tags: [ | |
"Values" | |
], | |
operationId: "Values_Get", | |
consumes: [ | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
type: "array", | |
items: { | |
type: "string" | |
} | |
} | |
} | |
}, | |
deprecated: false | |
}, | |
post: { | |
tags: [ | |
"Values" | |
], | |
operationId: "Values_Post", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
], | |
parameters: [ | |
{ | |
name: "value", | |
in: "body", | |
required: true, | |
schema: { | |
type: "string" | |
} | |
} | |
], | |
responses: { | |
204: { | |
description: "No Content" | |
} | |
}, | |
deprecated: false | |
} | |
}, | |
/api/Values/{ | |
id | |
}: { | |
get: { | |
tags: [ | |
"Values" | |
], | |
operationId: "Values_Get", | |
consumes: [ | |
], | |
produces: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml" | |
], | |
parameters: [ | |
{ | |
name: "id", | |
in: "path", | |
required: true, | |
type: "integer", | |
format: "int32" | |
} | |
], | |
responses: { | |
200: { | |
description: "OK", | |
schema: { | |
type: "string" | |
} | |
} | |
}, | |
deprecated: false | |
}, | |
put: { | |
tags: [ | |
"Values" | |
], | |
operationId: "Values_Put", | |
consumes: [ | |
"application/json", | |
"text/json", | |
"application/xml", | |
"text/xml", | |
"application/x-www-form-urlencoded" | |
], | |
produces: [ | |
], | |
parameters: [ | |
{ | |
name: "id", | |
in: "path", | |
required: true, | |
type: "integer", | |
format: "int32" | |
}, | |
{ | |
name: "value", | |
in: "body", | |
required: true, | |
schema: { | |
type: "string" | |
} | |
} | |
], | |
responses: { | |
204: { | |
description: "No Content" | |
} | |
}, | |
deprecated: false | |
}, | |
delete: { | |
tags: [ | |
"Values" | |
], | |
operationId: "Values_Delete", | |
consumes: [ | |
], | |
produces: [ | |
], | |
parameters: [ | |
{ | |
name: "id", | |
in: "path", | |
required: true, | |
type: "integer", | |
format: "int32" | |
} | |
], | |
responses: { | |
204: { | |
description: "No Content" | |
} | |
}, | |
deprecated: false | |
} | |
} | |
}, | |
definitions: { | |
UserInfoViewModel: { | |
type: "object", | |
properties: { | |
Email: { | |
type: "string" | |
}, | |
HasRegistered: { | |
type: "boolean" | |
}, | |
LoginProvider: { | |
type: "string" | |
} | |
} | |
}, | |
Object: { | |
type: "object", | |
properties: { | |
} | |
}, | |
ManageInfoViewModel: { | |
type: "object", | |
properties: { | |
LocalLoginProvider: { | |
type: "string" | |
}, | |
Email: { | |
type: "string" | |
}, | |
Logins: { | |
type: "array", | |
items: { | |
$ref: "#/definitions/UserLoginInfoViewModel" | |
} | |
}, | |
ExternalLoginProviders: { | |
type: "array", | |
items: { | |
$ref: "#/definitions/ExternalLoginViewModel" | |
} | |
} | |
} | |
}, | |
UserLoginInfoViewModel: { | |
type: "object", | |
properties: { | |
LoginProvider: { | |
type: "string" | |
}, | |
ProviderKey: { | |
type: "string" | |
} | |
} | |
}, | |
ExternalLoginViewModel: { | |
type: "object", | |
properties: { | |
Name: { | |
type: "string" | |
}, | |
Url: { | |
type: "string" | |
}, | |
State: { | |
type: "string" | |
} | |
} | |
}, | |
ChangePasswordBindingModel: { | |
required: [ | |
"OldPassword", | |
"NewPassword" | |
], | |
type: "object", | |
properties: { | |
OldPassword: { | |
type: "string" | |
}, | |
NewPassword: { | |
type: "string" | |
}, | |
ConfirmPassword: { | |
type: "string" | |
} | |
} | |
}, | |
SetPasswordBindingModel: { | |
required: [ | |
"NewPassword" | |
], | |
type: "object", | |
properties: { | |
NewPassword: { | |
type: "string" | |
}, | |
ConfirmPassword: { | |
type: "string" | |
} | |
} | |
}, | |
AddExternalLoginBindingModel: { | |
required: [ | |
"ExternalAccessToken" | |
], | |
type: "object", | |
properties: { | |
ExternalAccessToken: { | |
type: "string" | |
} | |
} | |
}, | |
RemoveLoginBindingModel: { | |
required: [ | |
"LoginProvider", | |
"ProviderKey" | |
], | |
type: "object", | |
properties: { | |
LoginProvider: { | |
type: "string" | |
}, | |
ProviderKey: { | |
type: "string" | |
} | |
} | |
}, | |
RegisterBindingModel: { | |
required: [ | |
"Email", | |
"Password" | |
], | |
type: "object", | |
properties: { | |
Email: { | |
type: "string" | |
}, | |
Password: { | |
type: "string" | |
}, | |
ConfirmPassword: { | |
type: "string" | |
} | |
} | |
}, | |
RegisterExternalBindingModel: { | |
required: [ | |
"Email" | |
], | |
type: "object", | |
properties: { | |
Email: { | |
type: "string" | |
} | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment