Background jobs
GET /v1/jobs/{id}
Section titled “GET /v1/jobs/{id}”Where a background job is. Ask again until status is done or failed;
Retry-After says how soon. A job and its result are kept for
RUSTICDOC_JOB_TTL after it ends, then removed.
Needs credentials, if any are configured.
Parameters
Section titled “Parameters”| Name | In | Required | Description |
|---|---|---|---|
id |
path | Yes | The job’s id, from the 202’s body or Location |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | The job | JobSchema |
| 404 | This caller has no such job, or it expired | ErrorBody |
| 501 | RUSTICDOC_STORE is not set | ErrorBody |
| 503 | The store cannot be reached | ErrorBody |
GET /v1/jobs/{id}/result
Section titled “GET /v1/jobs/{id}/result”Downloads what a finished job made, as the request would have answered it.
Needs credentials, if any are configured.
Parameters
Section titled “Parameters”| Name | In | Required | Description |
|---|---|---|---|
id |
path | Yes | The job’s id |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | The file | File |
| 404 | This caller has no such job, or it expired | ErrorBody |
| 409 | The job has not finished, or it failed | ErrorBody |
| 501 | RUSTICDOC_STORE is not set | ErrorBody |
| 503 | The store cannot be reached | ErrorBody |