From ee03105675934e9f1c457191aa8db9bebe728ff8 Mon Sep 17 00:00:00 2001 From: Lari Taskula Date: Fri, 10 Jun 2016 16:52:54 +0300 Subject: [PATCH] [SIGNED-OFF] Bug 16699: Add borrowernumberQueryParam for reusability MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The borrowernumber as a query parameter should be defined in parameters.json in order to allow its reusability. To test: 1. Apply patch 2. Run minifySwagger.pl 3. Validate swagger.min.json in online.swagger.io/validator/debug?url=url_to+ _your_swagger_min_json or your local swagger-api/validator-badge validator 4. Observe that validation passes Signed-off-by: Olli-Antti Kivilahti My name is Olli-Antti Kivilahti and I approve this commit. We have been using the Swagger2.0-driven REST API on Mojolicious for 1 year now in production and I am certain we have a pretty good idea on how to work with the limitations of Swagger2.0 We participated in the development of the Mojolicious::Plugin::Swagger and know it well. We have made an extension to the plugin to provide full CORS support and have been building all our in-house features on the new REST API. Signed-off-by: Johanna Raisa My name is Johanna Räisä and I approve this commit. We have been using Swagger2.0-driven REST API in production successfully. Signed-off-by: Benjamin Rokseth --- api/v1/parameters.json | 3 +++ api/v1/parameters/patron.json | 7 +++++++ api/v1/paths/holds.json | 5 +---- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/api/v1/parameters.json b/api/v1/parameters.json index 9778ac7..b20e19f 100644 --- a/api/v1/parameters.json +++ b/api/v1/parameters.json @@ -2,6 +2,9 @@ "borrowernumberPathParam": { "$ref": "parameters/patron.json#/borrowernumberPathParam" }, + "borrowernumberQueryParam": { + "$ref": "parameters/patron.json#/borrowernumberQueryParam" + }, "holdIdPathParam": { "$ref": "parameters/hold.json#/holdIdPathParam" } diff --git a/api/v1/parameters/patron.json b/api/v1/parameters/patron.json index 285ee04..2b204c1 100644 --- a/api/v1/parameters/patron.json +++ b/api/v1/parameters/patron.json @@ -5,5 +5,12 @@ "description": "Internal patron identifier", "required": true, "type": "integer" + }, + "borrowernumberQueryParam": { + "name": "borrowernumber", + "in": "query", + "description": "Internal borrower identifier", + "required": true, + "type": "integer" } } diff --git a/api/v1/paths/holds.json b/api/v1/paths/holds.json index a56e583..cd9713b 100644 --- a/api/v1/paths/holds.json +++ b/api/v1/paths/holds.json @@ -11,10 +11,7 @@ "type": "integer" }, { - "name": "borrowernumber", - "in": "query", - "description": "Internal borrower identifier", - "type": "integer" + "$ref": "../parameters.json#/borrowernumberQueryParam" }, { "name": "reservedate", -- 2.1.4