SAF Documentation

@saflib/jobs-spec

Interface: paths ​

This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

Properties ​

/jobs/cancel-by-original-request ​

/jobs/cancel-by-original-request: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Mass-cancel jobs in a request chain

Description ​

Cancels every non-terminal, non-running job that shares the given original_request_id (terminal_reason: cancelled-by-chain). Running jobs in the chain are left alone. Returns the jobs that were cancelled. Mounted as monolith chrome (site-admin-only).

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.original_request_id ​

original_request_id: string

Description ​

Chain-root request id whose non-running jobs should be cancelled.

Example ​
ts
r - abc123;
post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

Jobs that were cancelled in this chain.

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.jobs ​

jobs: object[]

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.401 ​

401: object

Description ​

Unauthorized - missing or invalid auth headers, or not logged in.

post.responses.401.content ​

content: object

post.responses.401.content.application/json ​

application/json: object

post.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.403 ​

403: object

Description ​

Forbidden - site admin privileges required.

post.responses.403.content ​

content: object

post.responses.403.content.application/json ​

application/json: object

post.responses.403.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.403.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined