Pedro Amorim
64c06fa87c
Koha/Illbackend.pm -> Koha/ILL/Backend.pm Koha/REST/V1/Illbackends.pm -> Koha/REST/V1/ILL/Backends.pm Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Pedro Amorim <pedro.amorim@ptfs-europe.com> Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
108 lines
No EOL
2.8 KiB
YAML
108 lines
No EOL
2.8 KiB
YAML
---
|
|
/ill/backends:
|
|
get:
|
|
x-mojo-to: ILL::Backends#list
|
|
operationId: listIllBackends
|
|
tags:
|
|
- ill_backends
|
|
summary: List ILL backends
|
|
parameters:
|
|
- 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: 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: ILL::Backends#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" |