Koha/api/v1/swagger/paths/acquisitions_funds.json
Matthias Meusburger 6e98cc4503 Bug 19661: Add and change properties and parameters to conform to the funds RFC.
Also, perform an exact search when searching on the fund owner id.

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2019-03-22 19:40:37 +00:00

73 lines
1.8 KiB
JSON

{
"/acquisitions/funds": {
"get": {
"x-mojo-to": "Acquisitions::Funds#list_funds",
"operationId": "listFunds",
"tags": ["acquisitions","funds"],
"produces": [
"application/json"
],
"parameters": [{
"name": "name",
"in": "query",
"description": "Case insensitive search on fund name",
"required": false,
"type": "string"
},
{
"name": "fund_owner_id",
"in": "query",
"description": "Display only the funds that belongs to the given patron ID",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "A list of funds",
"schema": {
"type": "array",
"items": {
"$ref": "../definitions.json#/fund"
}
}
},
"401": {
"description": "Authentication required",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"403": {
"description": "Access forbidden",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"404": {
"description": "Fund 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": {
"acquisition": "budget_manage_all"
}
}
}
}
}