SAF Documentation

Appearance

@saflib/cron-spec

Interface: paths ​

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

Properties ​

/cron/jobs ​

/cron/jobs: object

delete? ​

optional delete: undefined

get ​

get: object

List all cron jobs

get.parameters ​

parameters: object

optional cookie: undefined

get.parameters.header? ​

optional header: undefined

get.parameters.path? ​

optional path: undefined

get.parameters.query? ​

optional query: undefined

get.requestBody? ​

optional requestBody: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Description ​

A list of cron jobs.

get.responses.200.content ​

content: object

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

application/json: object[]

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

get.responses.401 ​

401: object

Description ​

Unauthorized - Invalid or missing authentication.

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 ​
ts
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 - Insufficient permissions (requires cron:read).

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 ​
ts
The requested resource could not be found.
get.responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown

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? ​

optional post: undefined

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/cron/jobs/settings ​

/cron/jobs/settings: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

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? ​

optional post: undefined

put ​

put: object

Update settings for a specific cron job by name

put.parameters ​

parameters: object

optional cookie: undefined

put.parameters.header? ​

optional header: undefined

put.parameters.path? ​

optional path: undefined

put.parameters.query? ​

optional query: undefined

put.requestBody ​

requestBody: object

Description ​

The job name and settings to update.

put.requestBody.content ​

content: object

put.requestBody.content.application/json ​

application/json: object

put.requestBody.content.application/json.enabled ​

enabled: boolean

Description ​

Set whether the job is enabled.

put.requestBody.content.application/json.jobName ​

jobName: string

Description ​

The name of the job to update.

put.responses ​

responses: object

put.responses.200 ​

200: object

Description ​

Job settings updated successfully.

put.responses.200.content ​

content: object

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

application/json: object

put.responses.200.content.application/json.createdAt? ​

readonly optional createdAt: string

Format: date-time

Description ​

Timestamp when the job setting was created.

put.responses.200.content.application/json.enabled ​

enabled: boolean

Description ​

Whether the job is enabled to run.

put.responses.200.content.application/json.id? ​

readonly optional id: number

Description ​

Unique identifier for the job setting.

put.responses.200.content.application/json.jobName ​

jobName: string

Description ​

The unique name of the cron job.

put.responses.200.content.application/json.lastRunAt? ​

optional lastRunAt: null | string

Format: date-time

Description ​

Timestamp of the last time the job ran.

put.responses.200.content.application/json.lastRunStatus? ​

optional lastRunStatus: null | "success" | "fail" | "running" | "timed out"

Description ​

Status of the last job run.

put.responses.200.content.application/json.updatedAt? ​

readonly optional updatedAt: string

Format: date-time

Description ​

Timestamp when the job setting was last updated.

put.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put.responses.401 ​

401: object

Description ​

Unauthorized - Invalid or missing authentication.

put.responses.401.content ​

content: object

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

application/json: object

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

optional code: string

Description ​

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

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

headers: object

Index Signature ​

[name: string]: unknown

put.responses.403 ​

403: object

Description ​

Forbidden - Insufficient permissions (requires cron:write).

put.responses.403.content ​

content: object

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

application/json: object

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

optional code: string

Description ​

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

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

headers: object

Index Signature ​

[name: string]: unknown

put.responses.404 ​

404: object

Description ​

Job setting with the specified name not found.

put.responses.404.content ​

content: object

put.responses.404.content.application/json ​

application/json: object

put.responses.404.content.application/json.code? ​

optional code: string

Description ​

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

put.responses.404.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
put.responses.404.headers ​

headers: object

Index Signature ​

[name: string]: unknown

trace? ​

optional trace: undefined