Koha/api/v1/swagger/paths/erm_eholdings_packages_resources.yaml
Jonathan Druart b7ae86a134
Bug 32923: Some fixes in ERM specs
Signed-off-by: Pedro Amorim <pedro.amorim@ptfs-europe.com>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-02-27 11:07:19 -03:00

82 lines
2.4 KiB
YAML

---
/erm/eholdings/{provider}/packages/{package_id}/resources:
get:
x-mojo-to: ERM::EHoldings::Resources#list
operationId: listErmEHoldingsPackagesResources
tags:
- eholdings
summary: List eholdings resources
produces:
- application/json
parameters:
- description: Provider name
in: path
name: provider
required: true
type: string
- description: Case insensitive search on resource_id
in: query
name: resource_id
required: false
type: string
- description: Case insensitive search on started_on
in: query
name: started_on
required: false
type: string
- description: Case insensitive search on ended_on
in: query
name: ended_on
required: false
type: string
- description: Case insensitive search on proxy
in: query
name: proxy
required: false
type: string
- $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
- $ref: "../swagger.yaml#/parameters/match"
- $ref: "../swagger.yaml#/parameters/order_by"
- $ref: "../swagger.yaml#/parameters/page"
- $ref: "../swagger.yaml#/parameters/per_page"
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
- $ref: "../swagger.yaml#/parameters/q_header"
- name: x-koha-embed
in: header
required: false
description: Embed list sent as a request header
type: array
items:
type: string
enum:
- title
collectionFormat: csv
responses:
200:
description: A list of eHoldings resources
schema:
items:
$ref: "../swagger.yaml#/definitions/erm_eholdings_resource"
type: array
400:
description: Bad request
schema:
$ref: "../swagger.yaml#/definitions/error"
403:
description: Access forbidden
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:
erm: 1