Koha/api/v1/swagger/definitions/job.yaml
Tomas Cohen Arazi 88cc881521
Bug 30982: API tweaks
This patch makes the following changes to the 'background_jobs' API:

* We now call them 'jobs'
* Removed deprecated query parameter definitions
* Added only_current query parameter
* Controller gets adapted to use $rs->filter_by_current when
  only_current is passed

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2022-09-23 08:57:49 -03:00

54 lines
968 B
YAML

---
type: object
properties:
job_id:
type: integer
description: internally assigned job identifier
readOnly: true
status:
description: job status
type: string
progress:
description: job progress
type:
- string
- "null"
size:
description: job size
type:
- string
- "null"
patron_id:
description: job enqueuer
type:
- string
- "null"
type:
description: job type
type: string
queue:
description: job queue
type: string
data:
description: job data
type: object
context:
description: job context
type: object
enqueued_date:
description: job enqueue date
type: string
format: date-time
started_date:
description: job start date
type:
- string
- "null"
format: date-time
ended_date:
description: job end date
type:
- string
- "null"
format: date-time
additionalProperties: false