Skip to content

Document the task-id query parameter #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HouMinXi wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −3
Open

Document the task-id query parameter #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
Loading