Koha/api/v1/swagger/paths/biblios.json
Tomas Cohen Arazi 4fb59c87ed
Bug 23677: OpenAPI spec for GET /biblios/{biblio_id}
Signed-off-by: Arthur Suzuki <arthur.suzuki@biblibre.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2019-10-08 14:33:34 +01:00

136 lines
3.1 KiB
JSON

{
"/biblios/{biblio_id}": {
"get": {
"x-mojo-to": "Biblios#get",
"operationId": "getBiblio",
"tags": [
"biblios"
],
"parameters": [
{
"$ref": "../parameters.json#/biblio_id_pp"
}
],
"produces": [
"application/json",
"application/marcxml+xml",
"application/marc-in-json",
"application/marc"
],
"responses": {
"200": {
"description": "A biblio"
},
"401": {
"description": "Authentication required",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"403": {
"description": "Access forbidden",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"404": {
"description": "Biblio not found",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"406": {
"description": "Not acceptable",
"schema": {
"type": "array",
"description": "Accepted content-types",
"items": {
"type": "string"
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"503": {
"description": "Under maintenance",
"schema": {
"$ref": "../definitions.json#/error"
}
}
},
"x-koha-authorization": {
"permissions": {
"catalogue": "1"
}
}
},
"delete": {
"x-mojo-to": "Biblios#delete",
"operationId": "deleteBiblio",
"tags": [
"biblios"
],
"parameters": [
{
"$ref": "../parameters.json#/biblio_id_pp"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "Biblio deleted",
"schema": {
"type": "string"
}
},
"401": {
"description": "Authentication required",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"403": {
"description": "Access forbidden",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"404": {
"description": "Biblio not found",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"409": {
"description": "Unable to perform action on biblio",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"503": {
"description": "Under maintenance",
"schema": {
"$ref": "../definitions.json#/error"
}
}
},
"x-koha-authorization": {
"permissions": {
"parameters": "edit_catalogue"
}
}
}
}
}