From d074fe53e5f3d9dcde4d87bd2dc846d084759a13 Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Fri, 24 Apr 2020 11:48:58 -0300 Subject: [PATCH] Bug 25279: Add general query parameters to the /cities route Signed-off-by: Tomas Cohen Arazi Signed-off-by: Kyle M Hall Signed-off-by: Jonathan Druart --- api/v1/swagger/paths/cities.json | 157 ++++++++++++++++++++----------- 1 file changed, 101 insertions(+), 56 deletions(-) diff --git a/api/v1/swagger/paths/cities.json b/api/v1/swagger/paths/cities.json index 01c7bed402..2a43d9ace9 100644 --- a/api/v1/swagger/paths/cities.json +++ b/api/v1/swagger/paths/cities.json @@ -3,35 +3,63 @@ "get": { "x-mojo-to": "Cities#list", "operationId": "listCities", - "tags": ["cities"], + "tags": [ + "cities" + ], "produces": [ "application/json" ], - "parameters": [{ - "name": "name", - "in": "query", - "description": "Case insensative search on city name", - "required": false, - "type": "string" - }, { - "name": "state", - "in": "query", - "description": "Case insensative search on city state", - "required": false, - "type": "string" - }, { - "name": "country", - "in": "query", - "description": "Case insensative search on city country", - "required": false, - "type": "string" - }, { - "name": "postal_code", - "in": "query", - "description": "Case Insensative search on city postal code", - "required": false, - "type": "string" - }], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Case insensative search on city name", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "Case insensative search on city state", + "required": false, + "type": "string" + }, + { + "name": "country", + "in": "query", + "description": "Case insensative search on city country", + "required": false, + "type": "string" + }, + { + "name": "postal_code", + "in": "query", + "description": "Case Insensative search on city postal code", + "required": false, + "type": "string" + }, + { + "$ref": "../parameters.json#/match" + }, + { + "$ref": "../parameters.json#/order_by" + }, + { + "$ref": "../parameters.json#/page" + }, + { + "$ref": "../parameters.json#/per_page" + }, + { + "$ref": "../parameters.json#/q_param" + }, + { + "$ref": "../parameters.json#/q_body" + }, + { + "$ref": "../parameters.json#/q_header" + } + ], "responses": { "200": { "description": "A list of cities", @@ -63,23 +91,27 @@ }, "x-koha-authorization": { "permissions": { - "catalogue": "1" + "catalogue": "1" } } }, "post": { "x-mojo-to": "Cities#add", "operationId": "addCity", - "tags": ["cities"], - "parameters": [{ - "name": "body", - "in": "body", - "description": "A JSON object containing informations about the new hold", - "required": true, - "schema": { - "$ref": "../definitions.json#/city" + "tags": [ + "cities" + ], + "parameters": [ + { + "name": "body", + "in": "body", + "description": "A JSON object containing informations about the new hold", + "required": true, + "schema": { + "$ref": "../definitions.json#/city" + } } - }], + ], "produces": [ "application/json" ], @@ -126,10 +158,14 @@ "get": { "x-mojo-to": "Cities#get", "operationId": "getCity", - "tags": ["cities"], - "parameters": [{ - "$ref": "../parameters.json#/city_id_pp" - }], + "tags": [ + "cities" + ], + "parameters": [ + { + "$ref": "../parameters.json#/city_id_pp" + } + ], "produces": [ "application/json" ], @@ -161,25 +197,30 @@ }, "x-koha-authorization": { "permissions": { - "catalogue": "1" + "catalogue": "1" } } }, "put": { "x-mojo-to": "Cities#update", "operationId": "updateCity", - "tags": ["cities"], - "parameters": [{ - "$ref": "../parameters.json#/city_id_pp" - }, { - "name": "body", - "in": "body", - "description": "A city object", - "required": true, - "schema": { - "$ref": "../definitions.json#/city" + "tags": [ + "cities" + ], + "parameters": [ + { + "$ref": "../parameters.json#/city_id_pp" + }, + { + "name": "body", + "in": "body", + "description": "A city object", + "required": true, + "schema": { + "$ref": "../definitions.json#/city" + } } - }], + ], "produces": [ "application/json" ], @@ -230,10 +271,14 @@ "delete": { "x-mojo-to": "Cities#delete", "operationId": "deleteCity", - "tags": ["cities"], - "parameters": [{ - "$ref": "../parameters.json#/city_id_pp" - }], + "tags": [ + "cities" + ], + "parameters": [ + { + "$ref": "../parameters.json#/city_id_pp" + } + ], "produces": [ "application/json" ], -- 2.20.1