Bug 20006: Spec changes
[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   "hold_id_pp": {
12     "$ref": "parameters/hold.json#/hold_id_pp"
13   },
14   "library_id_pp": {
15     "$ref": "parameters/library.json#/library_id_pp"
16   },
17   "vendoridPathParam": {
18     "$ref": "parameters/vendor.json#/vendoridPathParam"
19   },
20   "match": {
21     "name": "_match",
22     "in": "query",
23     "required": false,
24     "description": "Matching criteria",
25     "type": "string",
26     "enum": [
27         "contains",
28         "exact",
29         "starts_with",
30         "ends_with"
31     ]
32   },
33   "order_by": {
34     "name": "_order_by",
35     "in": "query",
36     "required": false,
37     "description": "Sorting criteria",
38     "type": "array",
39     "collectionFormat": "pipes",
40     "items": {
41         "type": "string"
42     }
43   },
44   "page": {
45     "name": "_page",
46     "in": "query",
47     "required": false,
48     "description": "Page number, for paginated object listing",
49     "type": "integer"
50   },
51   "per_page": {
52     "name": "_per_page",
53     "in": "query",
54     "required": false,
55     "description": "Page size, for paginated object listing",
56     "type": "integer"
57    }
58 }