SAF Documentation

Appearance

@saflib/jobs-spec

Interface: operations ​

Properties ​

cancelJobsByOriginalRequest ​

cancelJobsByOriginalRequest: object

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

requestBody ​

requestBody: object

requestBody.content ​

content: object

requestBody.content.application/json ​

application/json: object

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;

responses ​

responses: object

responses.200 ​

200: object

Description ​

Jobs that were cancelled in this chain.

responses.200.content ​

content: object

responses.200.content.application/json ​

application/json: object

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

jobs: object[]

responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.401 ​

401: object

Description ​

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

responses.401.content ​

content: object

responses.401.content.application/json ​

application/json: object

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

optional code: string

Description ​

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

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.
responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.403 ​

403: object

Description ​

Forbidden - site admin privileges required.

responses.403.content ​

content: object

responses.403.content.application/json ​

application/json: object

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

optional code: string

Description ​

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

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.
responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown