Attachment 52990 Details for Bug 16699 – [SIGNED-OFF] Bug 16699: Reference new x-primitives in currently defined objects

[patch] [SIGNED-OFF] Bug 16699: Reference new x-primitives in currently defined objects

SIGNED-OFF-Bug-16699-Reference-new-x-primitives-in.patch (text/plain), 4.51 KB, created by Johanna Räisä on 2016-06-30 13:52:45 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Johanna Räisä

Created: 2016-06-30 13:52:45 UTC

Size: 4.51 KB

patch

obsolete

>From 453240a6a75cdf8c6b36bbcf5e31b1b6ed5be718 Mon Sep 17 00:00:00 2001
>From: Lari Taskula <larit@student.uef.fi>
>Date: Tue, 14 Jun 2016 14:24:42 +0300
>Subject: [PATCH] [SIGNED-OFF] Bug 16699: Reference new x-primitives in
> currently defined objects
>MIME-Version: 1.0
>Content-Type: text/plain; charset=UTF-8
>Content-Transfer-Encoding: 8bit
>
>Since we have defined some basic x-primitives in x-primitives.json, we can now
>start to reuse them in our currently defined objects.
>
>To test:
>1. Apply patch
>2. Run minifySwagger.pl
>3. Validate your Swagger specifications
>4. Observe that validation passes
>
>Signed-off-by: Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi>
>
>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 <johanna.raisa@gmail.com>
>
>My name is Johanna RÃ¤isÃ¤ and I approve this commit.
>We have been using Swagger2.0-driven REST API in production successfully.
>---
> api/v1/definitions/hold.json   | 14 +++++---------
> api/v1/definitions/patron.json | 21 +++++++--------------
> 2 files changed, 12 insertions(+), 23 deletions(-)
>
>diff --git a/api/v1/definitions/hold.json b/api/v1/definitions/hold.json
>index d060810..dd08f3d 100644
>--- a/api/v1/definitions/hold.json
>+++ b/api/v1/definitions/hold.json
>@@ -2,22 +2,19 @@
>   "type": "object",
>   "properties": {
>     "reserve_id": {
>-      "description": "Internal hold identifier"
>+      "$ref": "../x-primitives.json#/reserve_id"
>     },
>     "borrowernumber": {
>-      "type": "string",
>-      "description": "internally assigned user identifier"
>+      "$ref": "../x-primitives.json#/borrowernumber"
>     },
>     "reservedate": {
>       "description": "the date the hold was placed"
>     },
>     "biblionumber": {
>-      "type": "string",
>-      "description": "internally assigned biblio identifier"
>+      "$ref": "../x-primitives.json#/biblionumber"
>     },
>     "branchcode": {
>-      "type": ["string", "null"],
>-      "description": "internally assigned branch identifier"
>+      "$ref": "../x-primitives.json#/branchcode"
>     },
>     "notificationdate": {
>       "description": "currently unused"
>@@ -41,8 +38,7 @@
>       "description": "date and time the hold was last updated"
>     },
>     "itemnumber": {
>-      "type": ["string", "null"],
>-      "description": "internally assigned item identifier"
>+      "$ref": "../x-primitives.json#/itemnumber"
>     },
>     "waitingdate": {
>       "description": "the date the item was marked as waiting for the patron at the library"
>diff --git a/api/v1/definitions/patron.json b/api/v1/definitions/patron.json
>index c5d8ff6..ec46273 100644
>--- a/api/v1/definitions/patron.json
>+++ b/api/v1/definitions/patron.json
>@@ -2,20 +2,16 @@
>   "type": "object",
>   "properties": {
>     "borrowernumber": {
>-      "type": "string",
>-      "description": "internally assigned user identifier"
>+      "$ref": "../x-primitives.json#/borrowernumber"
>     },
>     "cardnumber": {
>-      "type": ["string", "null"],
>-      "description": "library assigned user identifier"
>+      "$ref": "../x-primitives.json#/cardnumber"
>     },
>     "surname": {
>-      "type": "string",
>-      "description": "patron's last name"
>+      "$ref": "../x-primitives.json#/surname"
>     },
>     "firstname": {
>-      "type": ["string", "null"],
>-      "description": "patron's first name"
>+      "$ref": "../x-primitives.json#/firstname"
>     },
>     "title": {
>       "type": ["string", "null"],
>@@ -62,12 +58,10 @@
>       "description": "country of patron's primary address"
>     },
>     "email": {
>-      "type": ["string", "null"],
>-      "description": "primary email address for patron's primary address"
>+      "$ref": "../x-primitives.json#/email"
>     },
>     "phone": {
>-      "type": ["string", "null"],
>-      "description": "primary phone number for patron's primary address"
>+      "$ref": "../x-primitives.json#/phone"
>     },
>     "mobile": {
>       "type": ["string", "null"],
>@@ -130,8 +124,7 @@
>       "description": "patron's date of birth"
>     },
>     "branchcode": {
>-      "type": "string",
>-      "description": "code of patron's home branch"
>+      "$ref": "../x-primitives.json#/branchcode"
>     },
>     "categorycode": {
>       "type": "string",
>-- 
>1.9.1

Actions: View | Diff | Splinter Review

Attachments on bug 16699: 52375 | 52376 | 52377 | 52378 | 52379 | 52380 | 52580 | 52581 | 52956 | 52957 | 52958 | 52959 | 52960 | 52961 | 52962 | 52974 | 52975 | 52976 | 52978 | 52979 | 52980 | 52986 | 52987 | 52988 | 52989 | 52990 | 52991 | 54299 | 54300 | 54301 | 54302 | 54303 | 54304 | 54311 | 54372 | 54884 | 54885 | 54886 | 54887 | 54888 | 54889 | 54890 | 54891 | 54892