From cc64fdd278caf4143542ff6f4c626a69927720cf Mon Sep 17 00:00:00 2001 From: Agustin Moyano Date: Thu, 30 Jan 2020 19:20:42 +0000 Subject: [PATCH] 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. --- api/v1/swagger/parameters.json | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/api/v1/swagger/parameters.json b/api/v1/swagger/parameters.json index adc455018c..8c44dd14aa 100644 --- a/api/v1/swagger/parameters.json +++ b/api/v1/swagger/parameters.json @@ -70,6 +70,30 @@ "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" } -- 2.17.1