[skip ci] Updated swagger docs
This commit is contained in:
parent
fa6e1f8e49
commit
2fca6a46e5
|
|
@ -4151,7 +4151,7 @@ const docTemplate = `{
|
||||||
"JWTKeyAuth": []
|
"JWTKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Returns a single task identified by its per-project index. Useful when resolving human-readable references like \"PROJ-42\" to a canonical task object. Note that task indexes are reassigned when a task is moved between projects, so long-lived references should use the returned task id instead.",
|
"description": "Returns a single task identified by its per-project index. Useful when resolving human-readable references like \"PROJ-42\" to a canonical task object. The ` + "`" + `project` + "`" + ` path parameter accepts either a numeric project id or the project's identifier (e.g. \"PROJ\"); values consisting solely of digits are always interpreted as ids. Note that task indexes are reassigned when a task is moved between projects, so long-lived references should use the returned task id instead.",
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
|
@ -4164,8 +4164,8 @@ const docTemplate = `{
|
||||||
"summary": "Get one task by its per-project index",
|
"summary": "Get one task by its per-project index",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
"description": "The project ID",
|
"description": "The project id or the project's identifier",
|
||||||
"name": "project",
|
"name": "project",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"required": true
|
"required": true
|
||||||
|
|
|
||||||
|
|
@ -4143,7 +4143,7 @@
|
||||||
"JWTKeyAuth": []
|
"JWTKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Returns a single task identified by its per-project index. Useful when resolving human-readable references like \"PROJ-42\" to a canonical task object. Note that task indexes are reassigned when a task is moved between projects, so long-lived references should use the returned task id instead.",
|
"description": "Returns a single task identified by its per-project index. Useful when resolving human-readable references like \"PROJ-42\" to a canonical task object. The `project` path parameter accepts either a numeric project id or the project's identifier (e.g. \"PROJ\"); values consisting solely of digits are always interpreted as ids. Note that task indexes are reassigned when a task is moved between projects, so long-lived references should use the returned task id instead.",
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
|
@ -4156,8 +4156,8 @@
|
||||||
"summary": "Get one task by its per-project index",
|
"summary": "Get one task by its per-project index",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
"description": "The project ID",
|
"description": "The project id or the project's identifier",
|
||||||
"name": "project",
|
"name": "project",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"required": true
|
"required": true
|
||||||
|
|
|
||||||
|
|
@ -4435,14 +4435,17 @@ paths:
|
||||||
- application/json
|
- application/json
|
||||||
description: Returns a single task identified by its per-project index. Useful
|
description: Returns a single task identified by its per-project index. Useful
|
||||||
when resolving human-readable references like "PROJ-42" to a canonical task
|
when resolving human-readable references like "PROJ-42" to a canonical task
|
||||||
object. Note that task indexes are reassigned when a task is moved between
|
object. The `project` path parameter accepts either a numeric project id or
|
||||||
projects, so long-lived references should use the returned task id instead.
|
the project's identifier (e.g. "PROJ"); values consisting solely of digits
|
||||||
|
are always interpreted as ids. Note that task indexes are reassigned when
|
||||||
|
a task is moved between projects, so long-lived references should use the
|
||||||
|
returned task id instead.
|
||||||
parameters:
|
parameters:
|
||||||
- description: The project ID
|
- description: The project id or the project's identifier
|
||||||
in: path
|
in: path
|
||||||
name: project
|
name: project
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: string
|
||||||
- description: The task's per-project index
|
- description: The task's per-project index
|
||||||
in: path
|
in: path
|
||||||
name: index
|
name: index
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue