Martin Renvoize
9e50bcc1b5
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>
92 lines
2.7 KiB
YAML
92 lines
2.7 KiB
YAML
---
|
|
"/patrons/{patron_id}/account":
|
|
get:
|
|
x-mojo-to: Patrons::Account#get
|
|
operationId: getPatronAccount
|
|
tags:
|
|
- patrons
|
|
summary: Get account information for a patron
|
|
parameters:
|
|
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Patron's account balance
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/patron_balance"
|
|
"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:
|
|
borrowers: edit_borrowers
|
|
updatecharges: remaining_permissions
|
|
"/patrons/{patron_id}/account/credits":
|
|
post:
|
|
x-mojo-to: Patrons::Account#add_credit
|
|
operationId: addPatronCredit
|
|
tags:
|
|
- patrons
|
|
summary: Add credit to a patron's account
|
|
parameters:
|
|
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing credit information
|
|
required: true
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/patron_account_credit"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: Credit added
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/account_line"
|
|
"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:
|
|
updatecharges: remaining_permissions
|