Koha/api/v1/swagger/paths/acquisitions_vendor_issues.yaml
Marcel de Rooy 5a28ce57a0
Bug 33105: (QA follow-up) REST API
Includes removing q_header.
Inconsistent use of quotes for response codes.

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-07-20 10:59:29 -03:00

91 lines
2.7 KiB
YAML

---
"/acquisitions/vendors/{vendor_id}/issues":
get:
x-mojo-to: Acquisitions::Vendor::Issues#list
operationId: listVendorIssues
tags:
- vendors
summary: List vendor issues
produces:
- application/json
parameters:
- $ref: "../swagger.yaml#/parameters/vendor_id_pp"
- description: Case insensitive search on issue's id
in: query
name: issue_id
required: false
type: integer
- description: Case insensitive search on vendor's id
in: query
name: vendor_id
required: false
type: integer
- name: type
in: query
description: Case insensitive search on issue type
required: false
type: string
- description: Case insensitive search on issue start date
in: query
name: started_on
required: false
type: string
- description: Case insensitive search on issue end date
in: query
name: ended_on
required: false
type: string
- name: notes
in: query
description: Case insensitive search on issue's notes
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:
- +strings
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 issues
schema:
type: array
items:
$ref: "../swagger.yaml#/definitions/vendor_issue"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: Resource 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:
acquisition: issues_manage