Koha/api/v1/swagger/paths/erm_usage_titles.yaml
Matt Blenkinsop a811dc236b
Bug 35219: Fix ERM usage endpoints to show in docs
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>
2023-11-06 08:42:40 -03:00

112 lines
3.4 KiB
YAML

---
/erm/usage_titles:
get:
x-mojo-to: ERM::EUsage::UsageTitles#list
operationId: listErmUsageTitles
tags:
- erm_usage_titles
summary: List usage_titles
produces:
- application/json
parameters:
- description: Case insensitive search on usage_title title_id
in: query
name: title_id
required: false
type: integer
- description: Case insensitive search on usage_title title
in: query
name: title
required: false
type: string
- description: Case insensitive search on usage_title usage_data_provider_id
in: query
name: usage_data_provider_id
required: false
type: string
- description: Case insensitive search on usage_title title_doi
in: query
name: title_doi
required: false
type: string
- description: Case insensitive search on usage_title print_issn
in: query
name: print_issn
required: false
type: string
- description: Case insensitive search on usage_title online_issn
in: query
name: online_issn
required: false
type: string
- description: Case insensitive search on usage_title title_uri
in: query
name: title_uri
required: false
type: string
- description: Case insensitive search on usage_title 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
- description: Case insensitive search on usage_title yop
in: query
name: yop
required: false
type: string
- description: Case insensitive search on usage_title isbn
in: query
name: isbn
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_titles
schema:
items:
$ref: "../swagger.yaml#/definitions/erm_usage_title"
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