api/v1/swagger/paths/ill_backends.yaml

   1 ---
   2 /ill/backends:
   3   get:
   4     x-mojo-to: Illbackends#list
   5     operationId: listIllbackends
   6     tags:
   7       - ill_backends
   8     summary: List ILL backends
   9     parameters: []
  10     produces:
  11       - application/json
  12     responses:
  13       "200":
  14         description: A list of ILL backends
  15         schema:
  16           $ref: "../swagger.yaml#/definitions/ill_backends"
  17       "401":
  18         description: Authentication required
  19         schema:
  20           $ref: "../swagger.yaml#/definitions/error"
  21       "403":
  22         description: Access forbidden
  23         schema:
  24           $ref: "../swagger.yaml#/definitions/error"
  25       "404":
  26         description: ILL backends not found
  27         schema:
  28           $ref: "../swagger.yaml#/definitions/error"
  29       "500":
  30         description: |
  31           Internal server error. Possible `error_code` attribute values:
  32
  33           * `internal_server_error`
  34         schema:
  35           $ref: "../swagger.yaml#/definitions/error"
  36       "503":
  37         description: Under maintenance
  38         schema:
  39           $ref: "../swagger.yaml#/definitions/error"
  40     x-koha-authorization:
  41       permissions:
  42         ill: "1"
  43 "/ill/backends/{ill_backend_id}":
  44   get:
  45     x-mojo-to: Illbackends#get
  46     operationId: getIllbackends
  47     tags:
  48       - ill_backends
  49     summary: Get ILL backend
  50     parameters:
  51       - name: ill_backend_id
  52         in: path
  53         description: ILL backend id/name
  54         required: true
  55         type: string
  56     produces:
  57       - application/json
  58     responses:
  59       "200":
  60         description: An ILL backends
  61         schema:
  62           $ref: "../swagger.yaml#/definitions/ill_backend"
  63       "401":
  64         description: Authentication required
  65         schema:
  66           $ref: "../swagger.yaml#/definitions/error"
  67       "403":
  68         description: Access forbidden
  69         schema:
  70           $ref: "../swagger.yaml#/definitions/error"
  71       "404":
  72         description: ILL backends not found
  73         schema:
  74           $ref: "../swagger.yaml#/definitions/error"
  75       "500":
  76         description: |
  77           Internal server error. Possible `error_code` attribute values:
  78
  79           * `internal_server_error`
  80         schema:
  81           $ref: "../swagger.yaml#/definitions/error"
  82       "503":
  83         description: Under maintenance
  84         schema:
  85           $ref: "../swagger.yaml#/definitions/error"
  86     x-koha-authorization:
  87       permissions:
  88         ill: "1"
  89 "/ill/backends/{ill_backend_id}/statuses":
  90   get:
  91     x-mojo-to: Illbackends#list_statuses
  92     operationId: getIllbackendsStatuses
  93     tags:
  94       - ill_backends
  95     summary: Get existing ILL statuses
  96     parameters:
  97       - name: ill_backend_id
  98         in: path
  99         description: ILL backend id/name
 100         required: true
 101         type: string
 102     produces:
 103       - application/json
 104     responses:
 105       "200":
 106         description: A list of existing ILL statuses
 107         schema:
 108           $ref: "../swagger.yaml#/definitions/ill_statuses"
 109       "401":
 110         description: Authentication required
 111         schema:
 112           $ref: "../swagger.yaml#/definitions/error"
 113       "403":
 114         description: Access forbidden
 115         schema:
 116           $ref: "../swagger.yaml#/definitions/error"
 117       "404":
 118         description: ILL backends not found
 119         schema:
 120           $ref: "../swagger.yaml#/definitions/error"
 121       "500":
 122         description: |
 123           Internal server error. Possible `error_code` attribute values:
 124
 125           * `internal_server_error`
 126         schema:
 127           $ref: "../swagger.yaml#/definitions/error"
 128       "503":
 129         description: Under maintenance
 130         schema:
 131           $ref: "../swagger.yaml#/definitions/error"
 132     x-koha-authorization:
 133       permissions:
 134         ill: "1"