Matt Blenkinsop
a811dc236b
This patch fixes the tags and also adds the tags to the swagger.yaml file to allow the endpoints to be documented correctly. One endpoint has also been deleted as it is no longer required. Test plan: Check the attached files to see that all tags are now prefixed with 'erm_' and that the swagger file now includes an entry for all of these files Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
87 lines
No EOL
2.7 KiB
YAML
87 lines
No EOL
2.7 KiB
YAML
---
|
|
/erm/usage_databases:
|
|
get:
|
|
x-mojo-to: ERM::EUsage::UsageDatabases#list
|
|
operationId: listErmUsageDatabases
|
|
tags:
|
|
- erm_usage_databases
|
|
summary: List usage_databases
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- description: Case insensitive search on usage_database database_id
|
|
in: query
|
|
name: database_id
|
|
required: false
|
|
type: integer
|
|
- description: Case insensitive search on usage_database database
|
|
in: query
|
|
name: database
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on usage_database usage_data_provider_id
|
|
in: query
|
|
name: usage_data_provider_id
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on usage_database platform
|
|
in: query
|
|
name: platform
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on usage_database publisher
|
|
in: query
|
|
name: publisher
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on usage_title publisher_id
|
|
in: query
|
|
name: publisher_id
|
|
required: false
|
|
type: string
|
|
- name: x-koha-embed
|
|
in: header
|
|
required: false
|
|
description: Embed list sent as a request header
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- erm_usage_muses
|
|
- erm_usage_yuses
|
|
collectionFormat: csv
|
|
- $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/request_id_header"
|
|
responses:
|
|
200:
|
|
description: A list of usage_databases
|
|
schema:
|
|
items:
|
|
$ref: "../swagger.yaml#/definitions/erm_usage_database"
|
|
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 |