[skip ci] Updated swagger docs

This commit is contained in:
Frederick [Bot] 2026-05-19 09:43:17 +00:00
parent fa6e1f8e49
commit 2fca6a46e5
3 changed files with 13 additions and 10 deletions

View File

@ -4151,7 +4151,7 @@ const docTemplate = `{
"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": [
"application/json"
],
@ -4164,8 +4164,8 @@ const docTemplate = `{
"summary": "Get one task by its per-project index",
"parameters": [
{
"type": "integer",
"description": "The project ID",
"type": "string",
"description": "The project id or the project's identifier",
"name": "project",
"in": "path",
"required": true

View File

@ -4143,7 +4143,7 @@
"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": [
"application/json"
],
@ -4156,8 +4156,8 @@
"summary": "Get one task by its per-project index",
"parameters": [
{
"type": "integer",
"description": "The project ID",
"type": "string",
"description": "The project id or the project's identifier",
"name": "project",
"in": "path",
"required": true

View File

@ -4435,14 +4435,17 @@ paths:
- application/json
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.
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.
parameters:
- description: The project ID
- description: The project id or the project's identifier
in: path
name: project
required: true
type: integer
type: string
- description: The task's per-project index
in: path
name: index