Attachment 43214 Details for Bug 13799 – Bug 13799 - Followup: Refactor spec file

[patch] Bug 13799 - Followup: Refactor spec file

Bug-13799---Followup-Refactor-spec-file.patch (text/plain), 18.54 KB, created by Martin Renvoize (ashimema) on 2015-10-07 19:21:59 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Renvoize (ashimema)

Created: 2015-10-07 19:21:59 UTC

Size: 18.54 KB

patch

obsolete

>From 35cfe2ae39f692511ed0b7034180b1ef98a3d453 Mon Sep 17 00:00:00 2001
>From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
>Date: Wed, 7 Oct 2015 15:20:25 +0000
>Subject: [PATCH] Bug 13799 - Followup: Refactor spec file
>
>Spreading the specification over multiple files should lead to a more
>manageable specification long term
>---
> api/v1/definitions/error.json  |   9 ++
> api/v1/definitions/index.json  |   4 +
> api/v1/definitions/patron.json | 272 +++++++++++++++++++++++++++++++++++++++++
> api/v1/swagger.json            | 219 +--------------------------------
> 4 files changed, 286 insertions(+), 218 deletions(-)
> create mode 100644 api/v1/definitions/error.json
> create mode 100644 api/v1/definitions/index.json
> create mode 100644 api/v1/definitions/patron.json
>
>diff --git a/api/v1/definitions/error.json b/api/v1/definitions/error.json
>new file mode 100644
>index 0000000..e43673f
>--- /dev/null
>+++ b/api/v1/definitions/error.json
>@@ -0,0 +1,9 @@
>+{
>+  "type": "object",
>+  "properties": {
>+    "error": {
>+      "description": "Error message",
>+      "type": "string"
>+    }
>+  }
>+}
>diff --git a/api/v1/definitions/index.json b/api/v1/definitions/index.json
>new file mode 100644
>index 0000000..08e6b50
>--- /dev/null
>+++ b/api/v1/definitions/index.json
>@@ -0,0 +1,4 @@
>+{
>+    "patron": "patron.json",
>+    "error": "error.json"
>+}
>diff --git a/api/v1/definitions/patron.json b/api/v1/definitions/patron.json
>new file mode 100644
>index 0000000..8e23d91
>--- /dev/null
>+++ b/api/v1/definitions/patron.json
>@@ -0,0 +1,272 @@
>+{
>+      "type": "object",
>+      "properties": {
>+        "borrowernumber": {
>+          "type": "integer",
>+          "description": "internally assigned user identifier"
>+        },
>+        "cardnumber": {
>+          "type": "string",
>+          "description": "library assigned user identifier"
>+        },
>+        "surname": {
>+          "type": "string",
>+          "description": "patron's last name"
>+        },
>+        "firstname": {
>+          "type": "string",
>+          "description": "patron's first name"
>+        },
>+        "title": {
>+          "type": "string",
>+          "description": "patron's title"
>+        },
>+        "othernames": {
>+          "type": "string",
>+          "description": "any other names associated with the patron"
>+        },
>+        "initials": {
>+          "type": "string",
>+          "description": "initials of the patron"
>+        },
>+        "streetnumber": {
>+          "type": "string",
>+          "description": "street number of patron's primary address"
>+        },
>+        "streettype": {
>+          "type": "string",
>+          "description": "street type of patron's primary address"
>+        },
>+        "address": {
>+          "type": "string",
>+          "description": "first address line of patron's primary address"
>+        },
>+        "address2": {
>+          "type": "string",
>+          "description": "second address line of patron's primary address"
>+        },
>+        "city": {
>+          "type": "string",
>+          "description": "city or town of patron's primary address"
>+        },
>+        "state": {
>+          "type": "string",
>+          "description": "state or province of patron's primary address"
>+        },
>+        "zipcode": {
>+          "type": "string",
>+          "description": "zip or postal code of patron's primary address"
>+        },
>+        "country": {
>+          "type": "string",
>+          "description": "country of patron's primary address"
>+        },
>+        "email": {
>+          "type": "string",
>+          "description": "primary email address for patron's primary address"
>+        },
>+        "phone": {
>+          "type": "string",
>+          "description": "primary phone number for patron's primary address"
>+        },
>+        "mobile": {
>+          "type": "string",
>+          "description": "the other phone number for patron's primary address"
>+        },
>+        "fax": {
>+          "type": "string",
>+          "description": "fax number for patron's primary address"
>+        },
>+        "emailpro": {
>+          "type": "string",
>+          "description": "secondary email address for patron's primary address"
>+        },
>+        "phonepro": {
>+          "type": "string",
>+          "description": "secondary phone number for patron's primary address"
>+        },
>+        "B_streetnumber": {
>+          "type": "string",
>+          "description": "street number of patron's alternate address"
>+        },
>+        "B_streettype": {
>+          "type": "string",
>+          "description": "street type of patron's alternate address"
>+        },
>+        "B_address": {
>+          "type": "string",
>+          "description": "first address line of patron's alternate address"
>+        },
>+        "B_address2": {
>+          "type": "string",
>+          "description": "second address line of patron's alternate address"
>+        },
>+        "B_city": {
>+          "type": "string",
>+          "description": "city or town of patron's alternate address"
>+        },
>+        "B_state": {
>+          "type": "string",
>+          "description": "state or province of patron's alternate address"
>+        },
>+        "B_zipcode": {
>+          "type": "string",
>+          "description": "zip or postal code of patron's alternate address"
>+        },
>+        "B_country": {
>+          "type": "string",
>+          "description": "country of patron's alternate address"
>+        },
>+        "B_email": {
>+          "type": "string",
>+          "description": "email address for patron's alternate address"
>+        },
>+        "B_phone": {
>+          "type": "string",
>+          "description": "phone number for patron's alternate address"
>+        },
>+        "dateofbirth": {
>+          "type": "string",
>+          "description": "patron's date of birth"
>+        },
>+        "branchcode": {
>+          "type": "string",
>+          "description": "code of patron's home branch"
>+        },
>+        "categorycode": {
>+          "type": "string",
>+          "description": "code of patron's category"
>+        },
>+        "dateenrolled": {
>+          "type": "string",
>+          "description": "date the patron was added to Koha"
>+        },
>+        "dateexpiry": {
>+          "type": "string",
>+          "description": "date the patron's card is set to expire"
>+        },
>+        "gonenoaddress": {
>+          "type": "string",
>+          "description": "set to 1 if library marked this patron as having an unconfirmed address"
>+        },
>+        "lost": {
>+          "type": "string",
>+          "description": "set to 1 if library marked this patron as having lost his card"
>+        },
>+        "debarred": {
>+          "type": "string",
>+          "description": "until this date the patron can only check-in"
>+        },
>+        "debarredcomment": {
>+          "type": "string",
>+          "description": "comment on the stop of the patron"
>+        },
>+        "contactname": {
>+          "type": "string",
>+          "description": "used for children and professionals to include surname or last name of guarantor or organization name"
>+        },
>+        "contactfirstname": {
>+          "type": "string",
>+          "description": "used for children to include first name of guarantor"
>+        },
>+        "contacttitle": {
>+          "type": "string",
>+          "description": "used for children to include title of guarantor"
>+        },
>+        "guarantorid": {
>+          "type": "integer",
>+          "description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
>+        },
>+        "borrowernotes": {
>+          "type": "string",
>+          "description": "a note on the patron's account"
>+        },
>+        "relationship": {
>+          "type": "string",
>+          "description": "used for children to include the relationship to their guarantor"
>+        },
>+        "ethnicity": {
>+          "type": "string",
>+          "description": "unused"
>+        },
>+        "ethnotes": {
>+          "type": "string",
>+          "description": "unused"
>+        },
>+        "sex": {
>+          "type": "string",
>+          "description": "patron's gender"
>+        },
>+        "password": {
>+          "type": "string",
>+          "description": "patron's encrypted password"
>+        },
>+        "flags": {
>+          "type": "string",
>+          "description": "a number associated with the patron's permissions"
>+        },
>+        "userid": {
>+          "type": "string",
>+          "description": "patron's login"
>+        },
>+        "opacnote": {
>+          "type": "string",
>+          "description": "a note on the patron's account visible in OPAC and staff client"
>+        },
>+        "contactnote": {
>+          "type": "string",
>+          "description": "a note related to patron's alternate address"
>+        },
>+        "sort1": {
>+          "type": "string",
>+          "description": "a field that can be used for any information unique to the library"
>+        },
>+        "sort2": {
>+          "type": "string",
>+          "description": "a field that can be used for any information unique to the library"
>+        },
>+        "altcontactfirstname": {
>+          "type": "string",
>+          "description": "first name of alternate contact for the patron"
>+        },
>+        "altcontactsurname": {
>+          "type": "string",
>+          "description": "surname or last name of the alternate contact for the patron"
>+        },
>+        "altcontactaddress1": {
>+          "type": "string",
>+          "description": "the first address line for the alternate contact for the patron"
>+        },
>+        "altcontactaddress2": {
>+          "type": "string",
>+          "description": "the second address line for the alternate contact for the patron"
>+        },
>+        "altcontactaddress3": {
>+          "type": "string",
>+          "description": "the city for the alternate contact for the patron"
>+        },
>+        "altcontactstate": {
>+          "type": "string",
>+          "description": "the state for the alternate contact for the patron"
>+        },
>+        "altcontactzipcode": {
>+          "type": "string",
>+          "description": "the zipcode for the alternate contact for the patron"
>+        },
>+        "altcontactcountry": {
>+          "type": "string",
>+          "description": "the country for the alternate contact for the patron"
>+        },
>+        "altcontactphone": {
>+          "type": "string",
>+          "description": "the phone number for the alternate contact for the patron"
>+        },
>+        "smsalertnumber": {
>+          "type": "string",
>+          "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
>+        },
>+        "privacy": {
>+          "type": "string",
>+          "description": "patron's privacy settings related to their reading history"
>+        }
>+      }
>diff --git a/api/v1/swagger.json b/api/v1/swagger.json
>index d71dd7c..8f45b8d 100644
>--- a/api/v1/swagger.json
>+++ b/api/v1/swagger.json
>@@ -76,224 +76,7 @@
>     }
>   },
>   "definitions": {
>-    "patron": {
>-      "type": "object",
>-      "properties": {
>-        "borrowernumber": {
>-          "$ref": "#/definitions/borrowernumber"
>-        },
>-        "cardnumber": {
>-          "description": "library assigned ID number for patrons"
>-        },
>-        "surname": {
>-          "description": "patron's last name"
>-        },
>-        "firstname": {
>-          "description": "patron's first name"
>-        },
>-        "title": {
>-          "description": "patron's title"
>-        },
>-        "othernames": {
>-          "description": "any other names associated with the patron"
>-        },
>-        "initials": {
>-          "description": "initials of the patron"
>-        },
>-        "streetnumber": {
>-          "description": "street number of patron's primary address"
>-        },
>-        "streettype": {
>-          "description": "street type of patron's primary address"
>-        },
>-        "address": {
>-          "description": "first address line of patron's primary address"
>-        },
>-        "address2": {
>-          "description": "second address line of patron's primary address"
>-        },
>-        "city": {
>-          "description": "city or town of patron's primary address"
>-        },
>-        "state": {
>-          "description": "state or province of patron's primary address"
>-        },
>-        "zipcode": {
>-          "description": "zip or postal code of patron's primary address"
>-        },
>-        "country": {
>-          "description": "country of patron's primary address"
>-        },
>-        "email": {
>-          "description": "primary email address for patron's primary address"
>-        },
>-        "phone": {
>-          "description": "primary phone number for patron's primary address"
>-        },
>-        "mobile": {
>-          "description": "the other phone number for patron's primary address"
>-        },
>-        "fax": {
>-          "description": "fax number for patron's primary address"
>-        },
>-        "emailpro": {
>-          "description": "secondary email address for patron's primary address"
>-        },
>-        "phonepro": {
>-          "description": "secondary phone number for patron's primary address"
>-        },
>-        "B_streetnumber": {
>-          "description": "street number of patron's alternate address"
>-        },
>-        "B_streettype": {
>-          "description": "street type of patron's alternate address"
>-        },
>-        "B_address": {
>-          "description": "first address line of patron's alternate address"
>-        },
>-        "B_address2": {
>-          "description": "second address line of patron's alternate address"
>-        },
>-        "B_city": {
>-          "description": "city or town of patron's alternate address"
>-        },
>-        "B_state": {
>-          "description": "state or province of patron's alternate address"
>-        },
>-        "B_zipcode": {
>-          "description": "zip or postal code of patron's alternate address"
>-        },
>-        "B_country": {
>-          "description": "country of patron's alternate address"
>-        },
>-        "B_email": {
>-          "description": "email address for patron's alternate address"
>-        },
>-        "B_phone": {
>-          "description": "phone number for patron's alternate address"
>-        },
>-        "dateofbirth": {
>-          "description": "patron's date of birth"
>-        },
>-        "branchcode": {
>-          "description": "code of patron's home branch"
>-        },
>-        "categorycode": {
>-          "description": "code of patron's category"
>-        },
>-        "dateenrolled": {
>-          "description": "date the patron was added to Koha"
>-        },
>-        "dateexpiry": {
>-          "description": "date the patron's card is set to expire"
>-        },
>-        "gonenoaddress": {
>-          "description": "set to 1 if library marked this patron as having an unconfirmed address"
>-        },
>-        "lost": {
>-          "description": "set to 1 if library marked this patron as having lost his card"
>-        },
>-        "debarred": {
>-          "description": "until this date the patron can only check-in"
>-        },
>-        "debarredcomment": {
>-          "description": "comment on the stop of the patron"
>-        },
>-        "contactname": {
>-          "description": "used for children and professionals to include surname or last name of guarantor or organization name"
>-        },
>-        "contactfirstname": {
>-          "description": "used for children to include first name of guarantor"
>-        },
>-        "contacttitle": {
>-          "description": "used for children to include title of guarantor"
>-        },
>-        "guarantorid": {
>-          "description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
>-        },
>-        "borrowernotes": {
>-          "description": "a note on the patron's account"
>-        },
>-        "relationship": {
>-          "description": "used for children to include the relationship to their guarantor"
>-        },
>-        "ethnicity": {
>-          "description": "unused"
>-        },
>-        "ethnotes": {
>-          "description": "unused"
>-        },
>-        "sex": {
>-          "description": "patron's gender"
>-        },
>-        "password": {
>-          "description": "patron's encrypted password"
>-        },
>-        "flags": {
>-          "description": "a number associated with the patron's permissions"
>-        },
>-        "userid": {
>-          "description": "patron's login"
>-        },
>-        "opacnote": {
>-          "description": "a note on the patron's account visible in OPAC and staff client"
>-        },
>-        "contactnote": {
>-          "description": "a note related to patron's alternate address"
>-        },
>-        "sort1": {
>-          "description": "a field that can be used for any information unique to the library"
>-        },
>-        "sort2": {
>-          "description": "a field that can be used for any information unique to the library"
>-        },
>-        "altcontactfirstname": {
>-          "description": "first name of alternate contact for the patron"
>-        },
>-        "altcontactsurname": {
>-          "description": "surname or last name of the alternate contact for the patron"
>-        },
>-        "altcontactaddress1": {
>-          "description": "the first address line for the alternate contact for the patron"
>-        },
>-        "altcontactaddress2": {
>-          "description": "the second address line for the alternate contact for the patron"
>-        },
>-        "altcontactaddress3": {
>-          "description": "the city for the alternate contact for the patron"
>-        },
>-        "altcontactstate": {
>-          "description": "the state for the alternate contact for the patron"
>-        },
>-        "altcontactzipcode": {
>-          "description": "the zipcode for the alternate contact for the patron"
>-        },
>-        "altcontactcountry": {
>-          "description": "the country for the alternate contact for the patron"
>-        },
>-        "altcontactphone": {
>-          "description": "the phone number for the alternate contact for the patron"
>-        },
>-        "smsalertnumber": {
>-          "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
>-        },
>-        "privacy": {
>-          "description": "patron's privacy settings related to their reading history"
>-        }
>-      }
>-    },
>-    "borrowernumber": {
>-      "description": "Patron internal identifier"
>-    },
>-    "error": {
>-      "type": "object",
>-      "properties": {
>-        "error": {
>-          "description": "Error message",
>-          "type": "string"
>-        }
>-      }
>-    }
>+      "$ref": "./definitions/index.json"
>   },
>   "parameters": {
>     "borrowernumberPathParam": {
>-- 
>2.1.4

Actions: View | Diff | Splinter Review

Attachments on bug 13799: 36700 | 36705 | 36938 | 36941 | 37119 | 37132 | 37172 | 38246 | 39156 | 39158 | 39159 | 39160 | 39161 | 39162 | 39163 | 39164 | 40088 | 40092 | 40093 | 40094 | 40098 | 40099 | 40101 | 40140 | 40141 | 40142 | 40463 | 40464 | 40465 | 40466 | 40467 | 40468 | 40469 | 40470 | 40471 | 40551 | 40552 | 40553 | 40554 | 40560 | 40561 | 40584 | 40585 | 40586 | 40587 | 40616 | 40617 | 40618 | 40619 | 41160 | 41161 | 41162 | 41268 | 41269 | 41270 | 41271 | 41272 | 41273 | 41274 | 41320 | 41321 | 41326 | 41327 | 41328 | 41329 | 41330 | 41331 | 41538 | 41539 | 41540 | 41541 | 41542 | 41543 | 41547 | 41554 | 42044 | 42085 | 42086 | 42123 | 42518 | 42766 | 42768 | 42801 | 42874 | 42875 | 42876 | 42877 | 42878 | 43186 | 43187 | 43189 | 43190 | 43191 | 43192 | 43204 | 43205 | 43206 | 43207 | 43208 | 43209 | 43210 | 43211 | 43212 | 43213 | 43214 | 43980 | 43981 | 43987 | 43989 | 43990 | 43991 | 43992 | 43993 | 43994 | 43995 | 43996 | 43997 | 43998 | 43999 | 44000 | 44001 | 44185 | 44285 | 44313 | 44375 | 44376 | 44377 | 44378 | 44379 | 44380 | 44381 | 44382 | 44383 | 44384 | 44385