Swagger docs
continuous-integration/drone/pr Build is failing Details

This commit is contained in:
kolaente 2019-12-07 22:54:11 +01:00
parent 05eb98c973
commit 6f732fea13
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
1 changed files with 120 additions and 15 deletions

View File

@ -1,6 +1,6 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2019-12-07 20:29:10.551783293 +0100 CET m=+0.172017440
// 2019-12-07 22:54:02.661375666 +0100 CET m=+0.164990732
package swagger
@ -2649,7 +2649,7 @@ var doc = `{
"JWTKeyAuth": []
}
],
"description": "Returns one task by its ID",
"description": "Returns all tasks on any list the user has access to.",
"consumes": [
"application/json"
],
@ -2659,27 +2659,53 @@ var doc = `{
"tags": [
"task"
],
"summary": "Get one task",
"summary": "Get tasks",
"parameters": [
{
"type": "integer",
"description": "The task ID",
"name": "ID",
"in": "path",
"required": true
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search tasks by task text.",
"name": "s",
"in": "query"
},
{
"type": "string",
"description": "The sorting parameter. Possible values to sort by are priority, prioritydesc, priorityasc, duedate, duedatedesc, duedateasc.",
"name": "sort",
"in": "query"
},
{
"type": "integer",
"description": "The start date parameter to filter by. Expects a unix timestamp. If no end date, but a start date is specified, the end date is set to the current time.",
"name": "startdate",
"in": "query"
},
{
"type": "integer",
"description": "The end date parameter to filter by. Expects a unix timestamp. If no start date, but an end date is specified, the start date is set to the current time.",
"name": "enddate",
"in": "query"
}
],
"responses": {
"200": {
"description": "The task",
"description": "The tasks",
"schema": {
"$ref": "#/definitions/models.Task"
}
},
"404": {
"description": "Task not found",
"schema": {
"$ref": "#/definitions/models.Message"
"type": "array",
"items": {
"$ref": "#/definitions/models.Task"
}
}
},
"500": {
@ -2749,6 +2775,55 @@ var doc = `{
}
}
},
"/tasks/{ID}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns one task by its ID",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get one task",
"parameters": [
{
"type": "integer",
"description": "The task ID",
"name": "ID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The task",
"schema": {
"$ref": "#/definitions/models.Task"
}
},
"404": {
"description": "Task not found",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{id}": {
"post": {
"security": [
@ -4481,6 +4556,14 @@ var doc = `{
"description": "The unique, numeric id of this task.",
"type": "integer"
},
"identifier": {
"description": "The task identifier, based on the list identifier and the task's index",
"type": "string"
},
"index": {
"description": "The task index, calculated per list",
"type": "integer"
},
"labels": {
"description": "An array of labels which are associated with this task.",
"type": "array",
@ -4663,6 +4746,12 @@ var doc = `{
"description": "The unique, numeric id of this list.",
"type": "integer"
},
"identifier": {
"description": "The unique list short identifier. Used to build task identifiers.",
"type": "string",
"maxLength": 10,
"minLength": 0
},
"owner": {
"description": "The user who created this list.",
"type": "object",
@ -4894,6 +4983,14 @@ var doc = `{
"description": "The unique, numeric id of this task.",
"type": "integer"
},
"identifier": {
"description": "The task identifier, based on the list identifier and the task's index",
"type": "string"
},
"index": {
"description": "The task index, calculated per list",
"type": "integer"
},
"labels": {
"description": "An array of labels which are associated with this task.",
"type": "array",
@ -5002,6 +5099,14 @@ var doc = `{
"description": "The unique, numeric id of this task.",
"type": "integer"
},
"identifier": {
"description": "The task identifier, based on the list identifier and the task's index",
"type": "string"
},
"index": {
"description": "The task index, calculated per list",
"type": "integer"
},
"labels": {
"description": "An array of labels which are associated with this task.",
"type": "array",