Bug 19784: Adapt /v1/patrons to new naming guidelines
[koha.git] / api / v1 / swagger / parameters.json
1 {
2   "patron_id_pp": {
3     "$ref": "parameters/patron.json#/patron_id_pp"
4   },
5   "patron_id_qp": {
6     "$ref": "parameters/patron.json#/patron_id_qp"
7   },
8   "city_id_pp": {
9     "$ref": "parameters/city.json#/city_id_pp"
10   },
11   "holdIdPathParam": {
12     "$ref": "parameters/hold.json#/holdIdPathParam"
13   },
14   "vendoridPathParam": {
15     "$ref": "parameters/vendor.json#/vendoridPathParam"
16   },
17   "match": {
18     "name": "_match",
19     "in": "query",
20     "required": false,
21     "description": "Matching criteria",
22     "type": "string",
23     "enum": [
24         "contains",
25         "exact",
26         "starts_with",
27         "ends_with"
28     ]
29   },
30   "order_by": {
31     "name": "_order_by",
32     "in": "query",
33     "required": false,
34     "description": "Sorting criteria",
35     "type": "array",
36     "collectionFormat": "pipes",
37     "items": {
38         "type": "string"
39     }
40   },
41   "page": {
42     "name": "_page",
43     "in": "query",
44     "required": false,
45     "description": "Page number, for paginated object listing",
46     "type": "integer"
47   },
48   "per_page": {
49     "name": "_per_page",
50     "in": "query",
51     "required": false,
52     "description": "Page size, for paginated object listing",
53     "type": "integer"
54    }
55 }