Tomas Cohen Arazi
b7b6a85de5
This patch intends to be a guide for inserting Markdown documentation for error codes. The idea is that it can be copied and pasted as-is in new routes. And adapted to new error codes. To test: 1. Apply this patch 2. Run: $ npx redoc-cli@0.10.4 bundle --cdn --output index.html \ api/v1/swagger/swagger.yaml => SUCCESS: It builds correctly 3. Open index.tml on your browser 4. Pick a route, and see the 500 status description includes information about the possible `error_code` values. 5. Sign off :-D Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Andrew Fuerste-Henry <andrew@bywatersolutions.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
52 lines
1.4 KiB
YAML
52 lines
1.4 KiB
YAML
---
|
|
"/patrons/{patron_id}/holds":
|
|
get:
|
|
x-mojo-to: Patrons::Holds#list
|
|
operationId: getPatronHolds
|
|
tags:
|
|
- holds
|
|
summary: List holds for a patron
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/patron_id_pp
|
|
- $ref: ../parameters.yaml#/match
|
|
- $ref: ../parameters.yaml#/order_by
|
|
- $ref: ../parameters.yaml#/page
|
|
- $ref: ../parameters.yaml#/per_page
|
|
- $ref: ../parameters.yaml#/q_param
|
|
- $ref: ../parameters.yaml#/q_body
|
|
- $ref: ../parameters.yaml#/q_header
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: The patron holds
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/hold
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Patron not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: |
|
|
Internal server error. Possible `error_code` attribute values:
|
|
|
|
* `internal_server_error`
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
borrowers: edit_borrowers
|