Browse Source

Bug 28613: Add missing parameters to objects.search-based routes

The objects.search helper provides convenient ways to paginate and a 'q' filter parameter to build complex queries on this Koha::Objects-based routes.

Some routes were created prior to this feature getting introduced. We need to adjust the parameters for all existing objects.search-based routes.

This patch adds that.

The only GET (as in list) routes that would still be missing the
parameters are those about ILL, that are not objects.search based, and
probably need to be rewritten.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
21.11.x
Tomás Cohen Arazi 3 years ago
committed by Jonathan Druart
parent
commit
3e5046a029
  1. 12
      api/v1/swagger/paths/acquisitions_funds.json
  2. 6
      api/v1/swagger/paths/acquisitions_vendors.json
  3. 21
      api/v1/swagger/paths/advancededitormacros.json
  4. 6
      api/v1/swagger/paths/checkouts.json
  5. 9
      api/v1/swagger/paths/import_batch_profiles.json
  6. 9
      api/v1/swagger/paths/items.json

12
api/v1/swagger/paths/acquisitions_funds.json

@ -33,8 +33,16 @@
}, },
{ {
"$ref": "../parameters.json#/per_page" "$ref": "../parameters.json#/per_page"
} },
], {
"$ref": "../parameters.json#/q_param"
},
{
"$ref": "../parameters.json#/q_body"
},
{
"$ref": "../parameters.json#/q_header"
}],
"responses": { "responses": {
"200": { "200": {
"description": "A list of funds", "description": "A list of funds",

6
api/v1/swagger/paths/acquisitions_vendors.json

@ -28,6 +28,12 @@
"$ref": "../parameters.json#/page" "$ref": "../parameters.json#/page"
}, { }, {
"$ref": "../parameters.json#/per_page" "$ref": "../parameters.json#/per_page"
}, {
"$ref": "../parameters.json#/q_param"
}, {
"$ref": "../parameters.json#/q_body"
}, {
"$ref": "../parameters.json#/q_header"
}], }],
"responses": { "responses": {
"200": { "200": {

21
api/v1/swagger/paths/advancededitormacros.json

@ -36,6 +36,27 @@
"description": "Search on shared macros", "description": "Search on shared macros",
"required": false, "required": false,
"type": "string" "type": "string"
},
{
"$ref": "../parameters.json#/match"
},
{
"$ref": "../parameters.json#/order_by"
},
{
"$ref": "../parameters.json#/page"
},
{
"$ref": "../parameters.json#/per_page"
},
{
"$ref": "../parameters.json#/q_param"
},
{
"$ref": "../parameters.json#/q_body"
},
{
"$ref": "../parameters.json#/q_header"
} }
], ],
"responses": { "responses": {

6
api/v1/swagger/paths/checkouts.json

@ -15,6 +15,12 @@
"$ref": "../parameters.json#/match" "$ref": "../parameters.json#/match"
}, { }, {
"$ref": "../parameters.json#/order_by" "$ref": "../parameters.json#/order_by"
}, {
"$ref": "../parameters.json#/q_param"
}, {
"$ref": "../parameters.json#/q_body"
}, {
"$ref": "../parameters.json#/q_header"
},{ },{
"name": "checked_in", "name": "checked_in",
"in": "query", "in": "query",

9
api/v1/swagger/paths/import_batch_profiles.json

@ -26,6 +26,15 @@
}, },
{ {
"$ref": "../parameters.json#/per_page" "$ref": "../parameters.json#/per_page"
},
{
"$ref": "../parameters.json#/q_param"
},
{
"$ref": "../parameters.json#/q_body"
},
{
"$ref": "../parameters.json#/q_header"
} }
], ],
"consumes": [ "consumes": [

9
api/v1/swagger/paths/items.json

@ -26,6 +26,15 @@
}, },
{ {
"$ref": "../parameters.json#/per_page" "$ref": "../parameters.json#/per_page"
},
{
"$ref": "../parameters.json#/q_param"
},
{
"$ref": "../parameters.json#/q_body"
},
{
"$ref": "../parameters.json#/q_header"
} }
], ],
"consumes": [ "consumes": [

Loading…
Cancel
Save