Skip to content

Commit

Permalink
Link available background jobs in endpoint description
Browse files Browse the repository at this point in the history
  • Loading branch information
codello committed Sep 21, 2023
1 parent e280fe9 commit 686a227
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions openapi/tags/cron.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ tags:
- `media:prune`: This job deletes media files
- `upload:prune`: This job deletes uploads that have been soft-deleted.
- `upload:enqueue`: This job creates jobs for processing uploads.
If an upload processing job has been lost (e.g. because the redis instance failed)
this job recreates those jobs.
- `upload:enqueue`: This job creates tasks for processing uploads.
If an upload processing task has been lost (e.g. because the redis instance failed)
this job recreates those tasks.
- `song:prune`: This job deletes songs that have been soft-deleted.
The schedule for each job depends on the server settings.
Expand All @@ -35,7 +35,8 @@ paths:
summary: List Jobs
tags: [ cron ]
description: |-
Fetch all known jobs and their respective states.
Fetch all background jobs and their respective states.
See [Background Jobs](#tag/cron) for a description of the available jobs.
responses:
200:
x-summary: OK
Expand All @@ -51,8 +52,8 @@ paths:
scheduledAt: "2023-08-24T14:15:22Z"
upload:prune:
name: "upload:prune"
enabled: true
active: false
enabled: false
active: true
schema:
additionalProperties:
x-additionalPropertiesName: job
Expand All @@ -74,6 +75,7 @@ paths:
tags: [ cron ]
description: |-
Get status information about a single job.
See [Background Jobs](#tag/cron) for a description of the available jobs.
responses:
200:
x-summary: OK
Expand Down

0 comments on commit 686a227

Please sign in to comment.