Bug 24502: (follow-up) Add all 3 query parameters in api definition

This patch adds api definition for body, query or header parameters.

To use them include:

* "$ref": "../parameters.json#/q_body" for body parameter.
* "$ref": "../parameters.json#/q_param" for query parameter.
* "$ref": "../parameters.json#/q_header" for header parameter.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

diff --git a/api/v1/swagger/parameters.json b/api/v1/swagger/parameters.json
index adc4550..9c3d7eb 100644 (file)
--- a/api/v1/swagger/parameters.json
+++ b/api/v1/swagger/parameters.json
@@ -69,7 +69,30 @@
     "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"
   }