Koha/api/v1/swagger/paths/patrons_account.json
Tomas Cohen Arazi 566badf12a Bug 20944: OpenAPI spec for /patrons/{patron_id}/account/credits
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2018-08-31 12:46:59 +00:00

134 lines
3.2 KiB
JSON

{
"/patrons/{patron_id}/account": {
"get": {
"x-mojo-to": "Patrons::Account#get",
"operationId": "getPatronAccount",
"tags": [
"patron"
],
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Patron's account balance",
"schema": {
"$ref": "../definitions.json#/patron_balance"
}
},
"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,
"allow-guarantor": true,
"permissions": {
"borrowers": "edit_borrowers",
"updatecharges": "remaining_permissions"
}
}
}
},
"/patrons/{patron_id}/account/credits": {
"post": {
"x-mojo-to": "Patrons::Account#add_credit",
"operationId": "addPatronCredit",
"tags": [
"patron"
],
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
},
{
"name": "body",
"in": "body",
"description": "A JSON object containing credit information",
"required": true,
"schema": {
"$ref": "../definitions.json#/patron_account_credit"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Credit added",
"schema": {
"type": "object"
}
},
"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": {
"updatecharges": "remaining_permissions"
}
}
}
}
}