Koha/api/v1/swagger/paths/ill_backends.yaml
Pedro Amorim 50909d2266
Bug 22440: Move backend statuses api endpoint
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-05-05 09:13:43 -03:00

98 lines
No EOL
2.6 KiB
YAML

---
/ill/backends:
get:
x-mojo-to: Illbackends#list
operationId: listIllbackends
tags:
- ill_backends
summary: List ILL backends
parameters: []
produces:
- application/json
responses:
"200":
description: A list of ILL backends
schema:
$ref: "../swagger.yaml#/definitions/ill_backends"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: ILL backends not found
schema:
$ref: "../swagger.yaml#/definitions/error"
"500":
description: |
Internal server error. Possible `error_code` attribute values:
* `internal_server_error`
schema:
$ref: "../swagger.yaml#/definitions/error"
"503":
description: Under maintenance
schema:
$ref: "../swagger.yaml#/definitions/error"
x-koha-authorization:
permissions:
ill: "1"
"/ill/backends/{ill_backend_id}":
get:
x-mojo-to: Illbackends#get
operationId: getIllbackends
tags:
- ill_backends
summary: Get ILL backend
parameters:
- name: ill_backend_id
in: path
description: ILL backend id/name
required: true
type: string
- name: x-koha-embed
in: header
required: false
description: Embed list sent as a request header
type: array
items:
type: string
enum:
- statuses+strings
collectionFormat: csv
produces:
- application/json
responses:
"200":
description: An ILL backends
schema:
$ref: "../swagger.yaml#/definitions/ill_backend"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: ILL backends not found
schema:
$ref: "../swagger.yaml#/definitions/error"
"500":
description: |
Internal server error. Possible `error_code` attribute values:
* `internal_server_error`
schema:
$ref: "../swagger.yaml#/definitions/error"
"503":
description: Under maintenance
schema:
$ref: "../swagger.yaml#/definitions/error"
x-koha-authorization:
permissions:
ill: "1"