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>
"description":"This route is being deprecated and will be removed in future releases. Please migrate your project to use PATCH /holds/{hold_id} instead.",
"parameters":[{
"$ref":"../parameters.json#/hold_id_pp"
@ -469,6 +473,7 @@
"x-mojo-to":"Holds#delete",
"operationId":"deleteHold",
"tags":["holds"],
"summary":"Cancel hold",
"parameters":[{
"$ref":"../parameters.json#/hold_id_pp"
}
@ -523,6 +528,7 @@
"tags":[
"holds"
],
"summary":"Update priority for the hold",
"parameters":[
{
"$ref":"../parameters.json#/hold_id_pp"
@ -596,6 +602,7 @@
"x-mojo-to":"Holds#suspend",
"operationId":"suspendHold",
"tags":["holds"],
"summary":"Suspend the hold",
"parameters":[{
"$ref":"../parameters.json#/hold_id_pp"
},{
@ -669,6 +676,7 @@
"x-mojo-to":"Holds#resume",
"operationId":"resumeHold",
"tags":["holds"],
"summary":"Resume hold",
"parameters":[
{
"$ref":"../parameters.json#/hold_id_pp"
@ -729,6 +737,7 @@
"x-mojo-to":"Holds#pickup_locations",
"operationId":"getHoldPickupLocations",
"tags":["holds"],
"summary":"Get valid pickup locations for hold",
"parameters":[
{
"name":"x-koha-override",
@ -822,6 +831,8 @@
"x-mojo-to":"Holds#update_pickup_location",
"operationId":"updateHoldPickupLocation",
"tags":["holds"],
"summary":"Update pickup location for the hold",
"description":"Set a new pickup location for the hold",