NotAShelf
9e5eb41d39
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I4806c58aa0a17f504c9312723ad770166a6a6964
61 lines
1 KiB
Markdown
Vendored
61 lines
1 KiB
Markdown
Vendored
# Jobs
|
|
|
|
Background job management
|
|
|
|
## Endpoints
|
|
|
|
### GET /api/v1/jobs
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | ------------ |
|
|
| 200 | List of jobs |
|
|
| 401 | Unauthorized |
|
|
| 403 | Forbidden |
|
|
|
|
---
|
|
|
|
### GET /api/v1/jobs/{id}
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Parameters
|
|
|
|
| Name | In | Required | Description |
|
|
| ---- | ---- | -------- | ----------- |
|
|
| `id` | path | Yes | Job ID |
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | ------------ |
|
|
| 200 | Job details |
|
|
| 401 | Unauthorized |
|
|
| 403 | Forbidden |
|
|
| 404 | Not found |
|
|
|
|
---
|
|
|
|
### POST /api/v1/jobs/{id}/cancel
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Parameters
|
|
|
|
| Name | In | Required | Description |
|
|
| ---- | ---- | -------- | ----------- |
|
|
| `id` | path | Yes | Job ID |
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | ------------- |
|
|
| 200 | Job cancelled |
|
|
| 401 | Unauthorized |
|
|
| 403 | Forbidden |
|
|
| 404 | Not found |
|
|
|
|
---
|