Bug 17600: Fix opac/svc/overdrive
[koha.git] / api / v1 / swagger / parameters.json
1 {
2   "biblio_id_pp": {
3     "$ref": "parameters/biblio.json#/biblio_id_pp"
4   },
5   "advancededitormacro_id_pp": {
6     "$ref": "parameters/advancededitormacro.json#/advancededitormacro_id_pp"
7   },
8   "patron_id_pp": {
9     "$ref": "parameters/patron.json#/patron_id_pp"
10   },
11   "transfer_limit_id_pp": {
12     "$ref": "parameters/transfer_limit.json#/transfer_limit_id_pp"
13   },
14   "patron_id_qp": {
15     "$ref": "parameters/patron.json#/patron_id_qp"
16   },
17   "import_batch_profile_id_pp": {
18     "$ref": "parameters/import_batch_profile.json#/import_batch_profile_id_pp"
19   },
20   "city_id_pp": {
21     "$ref": "parameters/city.json#/city_id_pp"
22   },
23   "hold_id_pp": {
24     "$ref": "parameters/hold.json#/hold_id_pp"
25   },
26   "club_id_pp": {
27     "$ref": "parameters/club.json#/club_id_pp"
28   },
29   "library_id_pp": {
30     "$ref": "parameters/library.json#/library_id_pp"
31   },
32   "item_id_pp": {
33     "$ref": "parameters/item.json#/item_id_pp"
34   },
35   "order_id_pp": {
36     "$ref": "parameters/order.json#/order_id_pp"
37   },
38   "quote_id_pp": {
39     "$ref": "parameters/quote.json#/quote_id_pp"
40   },
41   "smtp_server_id_pp": {
42     "$ref": "parameters/smtp_server.json#/smtp_server_id_pp"
43   },
44   "vendoridPathParam": {
45     "$ref": "parameters/vendor.json#/vendoridPathParam"
46   },
47   "checkout_id_pp": {
48     "$ref": "parameters/checkout.json#/checkout_id_pp"
49   },
50   "seen_pp": {
51     "$ref": "parameters/checkout.json#/seen_pp"
52   },
53   "cash_register_id_pp": {
54     "$ref": "parameters/cash_register.json#/cash_register_id_pp"
55   },
56   "cashup_id_pp": {
57     "$ref": "parameters/cashup.json#/cashup_id_pp"
58   },
59   "match": {
60     "name": "_match",
61     "in": "query",
62     "required": false,
63     "description": "Matching criteria",
64     "type": "string",
65     "enum": [
66         "contains",
67         "exact",
68         "starts_with",
69         "ends_with"
70     ]
71   },
72   "order_by": {
73     "name": "_order_by",
74     "in": "query",
75     "required": false,
76     "description": "Sorting criteria",
77     "type": "array",
78     "collectionFormat": "csv",
79     "items": {
80         "type": "string"
81     }
82   },
83   "page": {
84     "name": "_page",
85     "in": "query",
86     "required": false,
87     "description": "Page number, for paginated object listing",
88     "type": "integer"
89   },
90   "per_page": {
91     "name": "_per_page",
92     "in": "query",
93     "required": false,
94     "description": "Page size, for paginated object listing",
95     "type": "integer"
96   },
97   "q_body": {
98     "name": "query",
99     "in": "body",
100     "required": false,
101     "description": "Query filter sent through request's body",
102     "schema": {
103       "type": ["object", "array"]
104     }
105   },
106   "q_param": {
107     "name": "q",
108     "in": "query",
109     "required": false,
110     "description": "Query filter sent as a request parameter",
111     "type": "string"
112   },
113   "q_header": {
114     "name": "x-koha-query",
115     "in": "header",
116     "required": false,
117     "description": "Query filter sent as a request header",
118     "type": "string"
119   },
120   "fundidPathParam": {
121     "$ref": "parameters/fund.json#/fundidPathParam"
122   }
123 }