Skip to content

[DOCS] Descriptions for tasks APIs #2263

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

Merged
merged 2 commits into from
Sep 4, 2023
Merged

[DOCS] Descriptions for tasks APIs #2263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6452540
[DOCS] Descriptions for tasks APIs
abdonpijpelink Sep 4, 2023
79166e3
Generate output
abdonpijpelink Sep 4, 2023
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
20 changes: 11 additions & 9 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions specification/tasks/cancel/CancelTasksRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,23 @@ import { TaskId } from '@_types/common'
*/
export interface Request extends RequestBase {
path_parts: {
/**
* ID of the task.
*/
task_id?: TaskId
}
query_parameters: {
/**
* Comma-separated list or wildcard expression of actions used to limit the request.
*/
actions?: string | string[]
/**
* Comma-separated list of node IDs or names used to limit the request.
*/
nodes?: string[]
/**
* Parent task ID used to limit the tasks.
*/
parent_task_id?: string
wait_for_completion?: boolean
}
Expand Down
12 changes: 12 additions & 0 deletions specification/tasks/get/GetTaskRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,22 @@ import { Duration } from '@_types/Time'
*/
export interface Request extends RequestBase {
path_parts: {
/**
* ID of the task.
*/
task_id: Id
}
query_parameters: {
/**
* Period to wait for a response.
* If no response is received before the timeout expires, the request fails and returns an error.
* @server_default 30s
*/
timeout?: Duration
/**
* If `true`, the request blocks until the task has completed.
* @server_default false
*/
wait_for_completion?: boolean
}
}