@saflib/jobs-spec

---

Interface: paths

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

Properties

/jobs

/jobs: object

delete?

optional delete: undefined

get

get: object

List jobs

Description

Admin list of queued jobs with optional filters and offset pagination. Mounted on the public app as monolith chrome (site-admin-only).

get.parameters

parameters: object

get.parameters.cookie?

optional cookie: undefined

get.parameters.header?

optional header: undefined

get.parameters.path?

optional path: undefined

get.parameters.query?

optional query: object

get.parameters.query.created_after?

optional created_after: string

Description

Only include jobs with created_at greater than or equal to this instant.

get.parameters.query.created_before?

optional created_before: string

Description

Only include jobs with created_at less than or equal to this instant.

get.parameters.query.limit?

optional limit: number

Description

Page size (default implementation-defined).

get.parameters.query.offset?

optional offset: number

Description

Number of matching jobs to skip before returning results.

get.parameters.query.operation_id?

optional operation_id: string

Description

Filter by target operationId.

get.parameters.query.original_request_id?

optional original_request_id: string

Description

Filter by chain-root request id.

get.parameters.query.status?

optional status: "pending" | "running" | "retrying" | "succeeded" | "dead" | "cancelled"

Description

Filter by job status.

get.parameters.query.user_id?

optional user_id: string

Description

Filter by acting user id.

get.requestBody?

optional requestBody: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Matching jobs for this page.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

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

jobs: object[]

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

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

get.responses.401.content

content: object

get.responses.401.content.application/json

application/json: object

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

optional code: string

Description

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

get.responses.401.content.application/json.message?

optional message: string

Description

A human-readable description of the error.

Example

The requested resource could not be found.

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden - site admin privileges required.

get.responses.403.content

content: object

get.responses.403.content.application/json

application/json: object

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

optional code: string

Description

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

get.responses.403.content.application/json.message?

optional message: string

Description

A human-readable description of the error.

Example

The requested resource could not be found.

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head: undefined

options?

optional options: undefined

parameters

parameters: object

parameters.cookie?

optional cookie: undefined

parameters.header?

optional header: undefined

parameters.path?

optional path: undefined

parameters.query?

optional query: undefined

patch?

optional patch: undefined

post?

optional post: undefined

put?

optional put: undefined

trace?

optional trace: undefined