863f129a58
This patch adds api definition for body, query or header parameters. To use them include: * "$ref": "../parameters.json#/q_body" for body parameter. * "$ref": "../parameters.json#/q_param" for query parameter. * "$ref": "../parameters.json#/q_header" for header parameter. Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
99 lines
2.2 KiB
JSON
99 lines
2.2 KiB
JSON
{
|
|
"biblio_id_pp": {
|
|
"$ref": "parameters/biblio.json#/biblio_id_pp"
|
|
},
|
|
"patron_id_pp": {
|
|
"$ref": "parameters/patron.json#/patron_id_pp"
|
|
},
|
|
"patron_id_qp": {
|
|
"$ref": "parameters/patron.json#/patron_id_qp"
|
|
},
|
|
"city_id_pp": {
|
|
"$ref": "parameters/city.json#/city_id_pp"
|
|
},
|
|
"hold_id_pp": {
|
|
"$ref": "parameters/hold.json#/hold_id_pp"
|
|
},
|
|
"club_id_pp": {
|
|
"$ref": "parameters/club.json#/club_id_pp"
|
|
},
|
|
"library_id_pp": {
|
|
"$ref": "parameters/library.json#/library_id_pp"
|
|
},
|
|
"item_id_pp": {
|
|
"$ref": "parameters/item.json#/item_id_pp"
|
|
},
|
|
"order_id_pp": {
|
|
"$ref": "parameters/order.json#/order_id_pp"
|
|
},
|
|
"vendoridPathParam": {
|
|
"$ref": "parameters/vendor.json#/vendoridPathParam"
|
|
},
|
|
"checkout_id_pp": {
|
|
"$ref": "parameters/checkout.json#/checkout_id_pp"
|
|
},
|
|
"match": {
|
|
"name": "_match",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Matching criteria",
|
|
"type": "string",
|
|
"enum": [
|
|
"contains",
|
|
"exact",
|
|
"starts_with",
|
|
"ends_with"
|
|
]
|
|
},
|
|
"order_by": {
|
|
"name": "_order_by",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Sorting criteria",
|
|
"type": "array",
|
|
"collectionFormat": "pipes",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"page": {
|
|
"name": "_page",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Page number, for paginated object listing",
|
|
"type": "integer"
|
|
},
|
|
"per_page": {
|
|
"name": "_per_page",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Page size, for paginated object listing",
|
|
"type": "integer"
|
|
},
|
|
"q_body": {
|
|
"name": "query",
|
|
"in": "body",
|
|
"required": false,
|
|
"description": "Query filter sent through request's body",
|
|
"schema": {
|
|
"type": ["object", "array"]
|
|
}
|
|
},
|
|
"q_param": {
|
|
"name": "q",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Query filter sent as a request parameter",
|
|
"type": "string"
|
|
},
|
|
"q_header": {
|
|
"name": "x-koha-query",
|
|
"in": "header",
|
|
"required": false,
|
|
"description": "Query filter sent as a request header",
|
|
"type": "string"
|
|
},
|
|
"fundidPathParam": {
|
|
"$ref": "parameters/fund.json#/fundidPathParam"
|
|
}
|
|
}
|