Update docs

This commit is contained in:
2018-11-13 19:03:26 +01:00
parent 1fd3c77194
commit f0b8345441
3 changed files with 44 additions and 260 deletions

View File

@ -15,64 +15,6 @@
},
"basePath": "/v1",
"paths": {
"/auth/": {
"get": {
"tags": [
"auth"
],
"description": "get Auth",
"operationId": "AuthController.GetAll",
"parameters": [
{
"in": "query",
"name": "query",
"description": "Filter. e.g. col1:v1,col2:v2 ...",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "Fields returned. e.g. col1,col2 ...",
"type": "string"
},
{
"in": "query",
"name": "sortby",
"description": "Sorted-by fields. e.g. col1,col2 ...",
"type": "string"
},
{
"in": "query",
"name": "order",
"description": "Order corresponding to each sortby field, if single value, apply to all sortby fields. e.g. desc,asc ...",
"type": "string"
},
{
"in": "query",
"name": "limit",
"description": "Limit the size of result set. Must be an integer",
"type": "string"
},
{
"in": "query",
"name": "offset",
"description": "Start position of result set. Must be an integer",
"type": "string"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/.Auth"
}
},
"403": {
"description": ""
}
}
}
},
"/auth/login": {
"post": {
"tags": [
@ -87,7 +29,7 @@
"description": "body for Auth content",
"required": true,
"schema": {
"$ref": "#/definitions/.Auth"
"$ref": "#/definitions/models.Auth"
}
}
],
@ -95,7 +37,7 @@
"201": {
"description": "",
"schema": {
"$ref": "#/definitions/.Auth"
"$ref": "#/definitions/models.Auth"
}
},
"403": {
@ -104,91 +46,33 @@
}
}
},
"/auth/{id}": {
"get": {
"/auth/register": {
"post": {
"tags": [
"auth"
],
"description": "get Auth by id",
"operationId": "AuthController.GetOne",
"description": "create Auth",
"operationId": "AuthController.Create",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The key for staticblock",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/.Auth"
}
},
"403": {
"description": ":id is empty"
}
}
},
"put": {
"tags": [
"auth"
],
"description": "update the Auth",
"operationId": "AuthController.Put",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to update",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "body for Auth content",
"required": true,
"schema": {
"$ref": "#/definitions/.Auth"
"$ref": "#/definitions/models.Auth"
}
}
],
"responses": {
"200": {
"201": {
"description": "",
"schema": {
"$ref": "#/definitions/.Auth"
"$ref": "#/definitions/models.Auth"
}
},
"403": {
"description": ":id is not int"
}
}
},
"delete": {
"tags": [
"auth"
],
"description": "delete the Auth",
"operationId": "AuthController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{string} delete success!"
},
"403": {
"description": "id is empty"
"description": "body is empty"
}
}
}
@ -887,7 +771,8 @@
}
},
"definitions": {
".Auth": {
"models.Auth": {
"title": "Auth",
"type": "object"
},
"models.CompanyData": {