Add task identifier (#115)
This commit is contained in:
konrad
@ -2631,7 +2631,7 @@
|
||||
"JWTKeyAuth": []
|
||||
}
|
||||
],
|
||||
"description": "Returns one task by its ID",
|
||||
"description": "Returns all tasks on any list the user has access to.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
@ -2641,27 +2641,53 @@
|
||||
"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": {
|
||||
@ -2731,6 +2757,55 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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": [
|
||||
@ -4462,6 +4537,14 @@
|
||||
"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",
|
||||
@ -4644,6 +4727,12 @@
|
||||
"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",
|
||||
@ -4875,6 +4964,14 @@
|
||||
"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",
|
||||
@ -4983,6 +5080,14 @@
|
||||
"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",
|
||||
|
||||
Reference in New Issue
Block a user