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>
172 lines
4.8 KiB
YAML
172 lines
4.8 KiB
YAML
---
|
|
"/public/patrons/{patron_id}/password":
|
|
post:
|
|
x-mojo-to: Patrons::Password#set_public
|
|
operationId: setPatronPasswordPublic
|
|
tags:
|
|
- patrons
|
|
summary: Set password for a patron (public)
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/patron_id_pp
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing password information
|
|
schema:
|
|
type: object
|
|
properties:
|
|
password:
|
|
description: New password (plain text)
|
|
type: string
|
|
password_repeated:
|
|
description: Repeated new password (plain text)
|
|
type: string
|
|
old_password:
|
|
description: Patron's original password
|
|
type: string
|
|
required:
|
|
- password
|
|
- password_repeated
|
|
- old_password
|
|
additionalProperties: false
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Password changed
|
|
"400":
|
|
description: Bad request
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"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:
|
|
allow-owner: true
|
|
"/public/patrons/{patron_id}/guarantors/can_see_charges":
|
|
put:
|
|
x-mojo-to: Patrons#guarantors_can_see_charges
|
|
operationId: setPatronGuarantorsCanSeeCharges
|
|
tags:
|
|
- patrons
|
|
summary: Set if guarantors can see charges (public)
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/patron_id_pp
|
|
- name: body
|
|
in: body
|
|
description: A boolean representing if guarantors should be able to see the
|
|
patron's charges
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
allowed:
|
|
type: boolean
|
|
additionalProperties: false
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Charges view policy for guarantors changed
|
|
"400":
|
|
description: Bad request
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"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:
|
|
allow-owner: true
|
|
"/public/patrons/{patron_id}/guarantors/can_see_checkouts":
|
|
put:
|
|
x-mojo-to: Patrons#guarantors_can_see_checkouts
|
|
operationId: setPatronGuarantorsCanSeeCheckouts
|
|
tags:
|
|
- patrons
|
|
summary: Set if guarantors can see checkouts
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/patron_id_pp
|
|
- name: body
|
|
in: body
|
|
description: A boolean representing if guarantors should be able to see the
|
|
patron's checkouts
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
allowed:
|
|
type: boolean
|
|
additionalProperties: false
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Check-out view policy for guarantors changed
|
|
"400":
|
|
description: Bad request
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"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:
|
|
allow-owner: true
|