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>
120 lines
3.7 KiB
JSON
120 lines
3.7 KiB
JSON
{
|
|
"/ill_backends": {
|
|
"get": {
|
|
"x-mojo-to": "Illbackends#list",
|
|
"operationId": "listIllbackends",
|
|
"tags": ["illbackends"],
|
|
"summary": "List ILL backends",
|
|
"parameters": [],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of ILL backends",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/ill_backends"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "ILL backends 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": {
|
|
"ill": "1"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ill_backends/{ill_backend_id}": {
|
|
"get": {
|
|
"x-mojo-to": "Illbackends#get",
|
|
"operationId": "getIllbackends",
|
|
"tags": ["illbackends"],
|
|
"summary": "Get ILL backend",
|
|
"parameters": [
|
|
{
|
|
"name": "ill_backend_id",
|
|
"in": "path",
|
|
"description": "ILL backend id/name",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An ILL backends",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/ill_backend"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "ILL backends 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": {
|
|
"ill": "1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|