Tomas Cohen Arazi
dc79aa0f40
This patch refactors the route specs a bit, and also reorganizes code for easier tracking. Unused exceptions that were added earlier are removed for now. A follow-up patch will add tests to this routes. Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
111 lines
3 KiB
YAML
111 lines
3 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: ../definitions.json#/error
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"404":
|
|
description: Patron not found
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"500":
|
|
description: Internal server error
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
reserveforothers: "1"
|
|
"/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: ../parameters.json#/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: ../definitions.json#/error
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"404":
|
|
description: Patron not found
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"500":
|
|
description: Internal server error
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.json#/error
|
|
x-koha-authorization:
|
|
allow-owner: true
|