Koha/api/v1/swagger/parameters.json
Martin Renvoize 9ba40e1adf Bug 26274: Add cashups api routes
This patch creates a Koha::Cash::Register::Cashup(s) class pair which
subclass Koha::Cash::Register::Action(s) and moves the cashup specific
code into these new classes to improve code separation.

We then introduce API routes based on these classes to allow fetching
a list of cashups associated to a cash register and a full cashup with
emeddable summary for individual cashups.

Test plan
1/ Run the updated unit tests.
   t/db_dependent/Koha/Cash/Register/Action.t
   t/db_dependent/Koha/Cash/Register/Cashup.t
2/ Run the incuded api tests.
   t/db_dependent/api/v1/cashups.t

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-02-12 12:33:41 +01:00

120 lines
2.8 KiB
JSON

{
"biblio_id_pp": {
"$ref": "parameters/biblio.json#/biblio_id_pp"
},
"advancededitormacro_id_pp": {
"$ref": "parameters/advancededitormacro.json#/advancededitormacro_id_pp"
},
"patron_id_pp": {
"$ref": "parameters/patron.json#/patron_id_pp"
},
"patron_id_qp": {
"$ref": "parameters/patron.json#/patron_id_qp"
},
"import_batch_profile_id_pp": {
"$ref": "parameters/import_batch_profile.json#/import_batch_profile_id_pp"
},
"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"
},
"quote_id_pp": {
"$ref": "parameters/quote.json#/quote_id_pp"
},
"smtp_server_id_pp": {
"$ref": "parameters/smtp_server.json#/smtp_server_id_pp"
},
"vendoridPathParam": {
"$ref": "parameters/vendor.json#/vendoridPathParam"
},
"checkout_id_pp": {
"$ref": "parameters/checkout.json#/checkout_id_pp"
},
"seen_pp": {
"$ref": "parameters/checkout.json#/seen_pp"
},
"cash_register_id_pp": {
"$ref": "parameters/cash_register.json#/cash_register_id_pp"
},
"cashup_id_pp": {
"$ref": "parameters/cashup.json#/cashup_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"
}
}