From 261e6ab8e71bc9a35e3309a659d1a908ad71aeb9 Mon Sep 17 00:00:00 2001 From: Minxi Hou Date: Sat, 24 Oct 2026 12:45:41 +0800 Subject: [PATCH] Document the task-id query parameter The status endpoints take the task identifier as ``task-id``: the handlers declare it with ``Query(alias="task-id")`` and the integration tests call them that way. The README spelled it ``task_id``, so a request built from the docs got a 400 instead of a status. Also mention the parameter on the ``/`` endpoint, which returns the status of an existing task when it is set, and note that ``/status/html`` redirects once the task has succeeded. Assisted-by: Hermes Agent --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6c52d7a..3b31513 100644 --- a/README.md +++ b/README.md @@ -74,18 +74,23 @@ if `format` is set to `html`. `json`, other options are `yaml`, `html` (serves as a basic human-readable output format) + * `task-id` - ID of an existing task - accepts a `string`, when set + the status of that task is returned instead of a new task being + created + ### `/status` Returns a status of the tmt object being processed by the backend. - * `task_id` - ID of the task - accepts a `string` + * `task-id` - ID of the task - accepts a `string` ### `/status/html` Returns a status of the tmt object being processed by the backend in a -simple HTML formatting. +simple HTML formatting. Once the task has succeeded, the response +redirects to the `/` endpoint where the rendered result is shown. - * `task_id` - ID of the task - accepts a `string` + * `task-id` - ID of the task - accepts a `string` ### `/health`