From 2fca6a46e5bf4eb7c1d74676554d95bc1fb682b4 Mon Sep 17 00:00:00 2001 From: "Frederick [Bot]" Date: Tue, 19 May 2026 09:43:17 +0000 Subject: [PATCH] [skip ci] Updated swagger docs --- pkg/swagger/docs.go | 6 +++--- pkg/swagger/swagger.json | 6 +++--- pkg/swagger/swagger.yaml | 11 +++++++---- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index a464c493a..170f81c20 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -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 diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index 9d2735d0d..2f58533f9 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -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 diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index c05086307..d51e61968 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -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