api/v1/swagger/paths/jobs.yaml

   1 ---
   2 /jobs:
   3   get:
   4     x-mojo-to: BackgroundJobs#list
   5     operationId: listJobs
   6     tags:
   7       - jobs
   8     summary: List jobs
   9     produces:
  10       - application/json
  11     parameters:
  12       - name: only_current
  13         in: query
  14         required: false
  15         type: boolean
  16         description: If should filter out not current jobs
  17       - $ref: "../swagger.yaml#/parameters/match"
  18       - $ref: "../swagger.yaml#/parameters/order_by"
  19       - $ref: "../swagger.yaml#/parameters/page"
  20       - $ref: "../swagger.yaml#/parameters/per_page"
  21       - $ref: "../swagger.yaml#/parameters/q_param"
  22       - $ref: "../swagger.yaml#/parameters/q_body"
  23       - $ref: "../swagger.yaml#/parameters/q_header"
  24       - $ref: "../swagger.yaml#/parameters/request_id_header"
  25     responses:
  26       "200":
  27         description: A list of jobs
  28         schema:
  29           type: array
  30           items:
  31             $ref: "../swagger.yaml#/definitions/job"
  32       "403":
  33         description: Access forbidden
  34         schema:
  35           $ref: "../swagger.yaml#/definitions/error"
  36       "500":
  37         description: |
  38           Internal server error. Possible `error_code` attribute values:
  39
  40           * `internal_server_error`
  41         schema:
  42           $ref: "../swagger.yaml#/definitions/error"
  43       "503":
  44         description: Under maintenance
  45         schema:
  46           $ref: "../swagger.yaml#/definitions/error"
  47     x-koha-authorization:
  48       permissions:
  49         catalogue: "1"
  50 "/jobs/{job_id}":
  51   get:
  52     x-mojo-to: BackgroundJobs#get
  53     operationId: getJob
  54     tags:
  55       - jobs
  56     summary: Get a job
  57     parameters:
  58       - $ref: "../swagger.yaml#/parameters/job_id_pp"
  59     produces:
  60       - application/json
  61     responses:
  62       "200":
  63         description: A job
  64         schema:
  65           $ref: "../swagger.yaml#/definitions/job"
  66       "403":
  67         description: Access forbidden
  68         schema:
  69           $ref: "../swagger.yaml#/definitions/error"
  70       "404":
  71         description: Job not found
  72         schema:
  73           $ref: "../swagger.yaml#/definitions/error"
  74       "500":
  75         description: |
  76           Internal server error. Possible `error_code` attribute values:
  77
  78           * `internal_server_error`
  79         schema:
  80           $ref: "../swagger.yaml#/definitions/error"
  81       "503":
  82         description: Under maintenance
  83         schema:
  84           $ref: "../swagger.yaml#/definitions/error"
  85     x-koha-authorization:
  86       permissions:
  87         catalogue: "1"