Koha/api/v1/swagger/paths/article_requests.yaml
Martin Renvoize 9e50bcc1b5 Bug 30194: (follow-up) Simply OpenAPI Specification
This patch simplifies the specification directory further by doing the
following:

* Inlines paths.yml into swagger.yaml
* Inlines definitions.yaml into swagger.yaml
* Inlines parameters.yaml into swagger.yaml
* Drops x-primitives.yaml

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
2022-03-29 16:44:31 +02:00

117 lines
3.4 KiB
YAML

---
"/article_requests/{article_request_id}":
delete:
x-mojo-to: ArticleRequests#cancel
operationId: cancelArticleRequest
tags:
- article_requests
summary: Cancel article requests
parameters:
- name: article_request_id
in: path
description: Article request identifier
required: true
type: integer
- name: cancellation_reason
in: query
description: Article request cancellation reason
required: false
type: string
- name: notes
in: query
description: Article request custom cancellation reason
required: false
type: string
produces:
- application/json
responses:
"204":
description: Article request canceled
"400":
description: Bad request
schema:
$ref: "../swagger.yaml#/definitions/error"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: Patron 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:
circulate: circulate_remaining_permissions
"/public/patrons/{patron_id}/article_requests/{article_request_id}":
delete:
x-mojo-to: ArticleRequests#patron_cancel
operationId: publicCancelPatronArticleRequest
tags:
- article_requests
summary: Cancel patron's article requests
parameters:
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
- name: article_request_id
in: path
description: Article request identifier
required: true
type: integer
- name: cancellation_reason
in: query
description: Article request cancellation reason
required: false
type: string
- name: notes
in: query
description: Article request custom cancellation reason
required: false
type: string
produces:
- application/json
responses:
"204":
description: Patron's article request canceled
"400":
description: Bad request
schema:
$ref: "../swagger.yaml#/definitions/error"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: Patron 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:
allow-owner: true