Tomas Cohen Arazi
748b2e91a3
This patch adds a 'summary' entry to all routes and verbs. This way, ReDoc will display a human-friendly description of the route, instead of the operationId. To test, repeat the testing steps in the previous patch, and notice that we now have good descriptions. Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
109 lines
3.4 KiB
JSON
109 lines
3.4 KiB
JSON
{
|
|
"/cash_registers/{cash_register_id}/cashups": {
|
|
"get": {
|
|
"x-mojo-to": "CashRegisters::Cashups#list",
|
|
"operationId": "listCashups",
|
|
"tags": ["cashups"],
|
|
"summary": "List cashups for the cash register",
|
|
"produces": ["application/json"],
|
|
"parameters": [{
|
|
"$ref": "../parameters.json#/cash_register_id_pp"
|
|
},
|
|
{
|
|
"$ref": "../parameters.json#/match"
|
|
},
|
|
{
|
|
"$ref": "../parameters.json#/order_by"
|
|
},
|
|
{
|
|
"$ref": "../parameters.json#/page"
|
|
},
|
|
{
|
|
"$ref": "../parameters.json#/per_page"
|
|
},
|
|
{
|
|
"$ref": "../parameters.json#/q_param"
|
|
},
|
|
{
|
|
"$ref": "../parameters.json#/q_body"
|
|
},
|
|
{
|
|
"$ref": "../parameters.json#/q_header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Cashups performed on this register",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "../definitions.json#/cashup"
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Register not found",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
}
|
|
},
|
|
"x-koha-authorization": {
|
|
"permissions": {
|
|
"cash_management": "cashup"
|
|
}
|
|
},
|
|
"x-koha-embed": [
|
|
"manager"
|
|
]
|
|
}
|
|
},
|
|
"/cashups/{cashup_id}": {
|
|
"get": {
|
|
"x-mojo-to": "CashRegisters::Cashups#get",
|
|
"operationId": "getCashup",
|
|
"tags": ["cashups"],
|
|
"summary": "Get cashup",
|
|
"parameters": [{
|
|
"$ref": "../parameters.json#/cashup_id_pp"
|
|
}],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A cashup",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/cashup"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Patron not found",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
}
|
|
},
|
|
"x-koha-authorization": {
|
|
"permissions": {
|
|
"cash_management": "cashup"
|
|
}
|
|
},
|
|
"x-koha-embed": [
|
|
"summary"
|
|
]
|
|
}
|
|
}
|
|
}
|