From 1338db3d55700ec9e56c7ec7255a3ac5875aa394 Mon Sep 17 00:00:00 2001 From: Julian Maurice Date: Mon, 26 Oct 2015 11:43:35 +0100 Subject: [PATCH] [PASSED QA] Bug 13799: Followup of "Followup: x-mojo-controller deprecation" Rename controller Koha::REST::V1::Patrons to Koha::REST::V1::Patron so Swagger2 can find it Also change most of the "type" specifications in patron schema object, since most of the fields can be null. Signed-off-by: Kyle M Hall --- Koha/REST/V1/{Patrons.pm => Patron.pm} | 2 +- api/v1/definitions/patron.json | 122 ++++++++++++++++---------------- 2 files changed, 62 insertions(+), 62 deletions(-) rename Koha/REST/V1/{Patrons.pm => Patron.pm} (98%) diff --git a/Koha/REST/V1/Patrons.pm b/Koha/REST/V1/Patron.pm similarity index 98% rename from Koha/REST/V1/Patrons.pm rename to Koha/REST/V1/Patron.pm index dfeb1dc..fee6c31 100644 --- a/Koha/REST/V1/Patrons.pm +++ b/Koha/REST/V1/Patron.pm @@ -1,4 +1,4 @@ -package Koha::REST::V1::Patrons; +package Koha::REST::V1::Patron; # This file is part of Koha. # diff --git a/api/v1/definitions/patron.json b/api/v1/definitions/patron.json index 1b35785..30384e2 100644 --- a/api/v1/definitions/patron.json +++ b/api/v1/definitions/patron.json @@ -2,11 +2,11 @@ "type": "object", "properties": { "borrowernumber": { - "type": "integer", + "type": "string", "description": "internally assigned user identifier" }, "cardnumber": { - "type": "string", + "type": ["string", "null"], "description": "library assigned user identifier" }, "surname": { @@ -14,27 +14,27 @@ "description": "patron's last name" }, "firstname": { - "type": "string", + "type": ["string", "null"], "description": "patron's first name" }, "title": { - "type": "string", + "type": ["string", "null"], "description": "patron's title" }, "othernames": { - "type": "string", + "type": ["string", "null"], "description": "any other names associated with the patron" }, "initials": { - "type": "string", + "type": ["string", "null"], "description": "initials of the patron" }, "streetnumber": { - "type": "string", + "type": ["string", "null"], "description": "street number of patron's primary address" }, "streettype": { - "type": "string", + "type": ["string", "null"], "description": "street type of patron's primary address" }, "address": { @@ -42,7 +42,7 @@ "description": "first address line of patron's primary address" }, "address2": { - "type": "string", + "type": ["string", "null"], "description": "second address line of patron's primary address" }, "city": { @@ -50,83 +50,83 @@ "description": "city or town of patron's primary address" }, "state": { - "type": "string", + "type": ["string", "null"], "description": "state or province of patron's primary address" }, "zipcode": { - "type": "string", + "type": ["string", "null"], "description": "zip or postal code of patron's primary address" }, "country": { - "type": "string", + "type": ["string", "null"], "description": "country of patron's primary address" }, "email": { - "type": "string", + "type": ["string", "null"], "description": "primary email address for patron's primary address" }, "phone": { - "type": "string", + "type": ["string", "null"], "description": "primary phone number for patron's primary address" }, "mobile": { - "type": "string", + "type": ["string", "null"], "description": "the other phone number for patron's primary address" }, "fax": { - "type": "string", + "type": ["string", "null"], "description": "fax number for patron's primary address" }, "emailpro": { - "type": "string", + "type": ["string", "null"], "description": "secondary email address for patron's primary address" }, "phonepro": { - "type": "string", + "type": ["string", "null"], "description": "secondary phone number for patron's primary address" }, "B_streetnumber": { - "type": "string", + "type": ["string", "null"], "description": "street number of patron's alternate address" }, "B_streettype": { - "type": "string", + "type": ["string", "null"], "description": "street type of patron's alternate address" }, "B_address": { - "type": "string", + "type": ["string", "null"], "description": "first address line of patron's alternate address" }, "B_address2": { - "type": "string", + "type": ["string", "null"], "description": "second address line of patron's alternate address" }, "B_city": { - "type": "string", + "type": ["string", "null"], "description": "city or town of patron's alternate address" }, "B_state": { - "type": "string", + "type": ["string", "null"], "description": "state or province of patron's alternate address" }, "B_zipcode": { - "type": "string", + "type": ["string", "null"], "description": "zip or postal code of patron's alternate address" }, "B_country": { - "type": "string", + "type": ["string", "null"], "description": "country of patron's alternate address" }, "B_email": { - "type": "string", + "type": ["string", "null"], "description": "email address for patron's alternate address" }, "B_phone": { - "type": "string", + "type": ["string", "null"], "description": "phone number for patron's alternate address" }, "dateofbirth": { - "type": "string", + "type": ["string", "null"], "description": "patron's date of birth" }, "branchcode": { @@ -138,131 +138,131 @@ "description": "code of patron's category" }, "dateenrolled": { - "type": "string", + "type": ["string", "null"], "description": "date the patron was added to Koha" }, "dateexpiry": { - "type": "string", + "type": ["string", "null"], "description": "date the patron's card is set to expire" }, "gonenoaddress": { - "type": "string", + "type": ["string", "null"], "description": "set to 1 if library marked this patron as having an unconfirmed address" }, "lost": { - "type": "string", + "type": ["string", "null"], "description": "set to 1 if library marked this patron as having lost his card" }, "debarred": { - "type": "string", + "type": ["string", "null"], "description": "until this date the patron can only check-in" }, "debarredcomment": { - "type": "string", + "type": ["string", "null"], "description": "comment on the stop of the patron" }, "contactname": { - "type": "string", + "type": ["string", "null"], "description": "used for children and professionals to include surname or last name of guarantor or organization name" }, "contactfirstname": { - "type": "string", + "type": ["string", "null"], "description": "used for children to include first name of guarantor" }, "contacttitle": { - "type": "string", + "type": ["string", "null"], "description": "used for children to include title of guarantor" }, "guarantorid": { - "type": "integer", + "type": ["string", "null"], "description": "borrowernumber used for children or professionals to link them to guarantor or organizations" }, "borrowernotes": { - "type": "string", + "type": ["string", "null"], "description": "a note on the patron's account" }, "relationship": { - "type": "string", + "type": ["string", "null"], "description": "used for children to include the relationship to their guarantor" }, "ethnicity": { - "type": "string", + "type": ["string", "null"], "description": "unused" }, "ethnotes": { - "type": "string", + "type": ["string", "null"], "description": "unused" }, "sex": { - "type": "string", + "type": ["string", "null"], "description": "patron's gender" }, "password": { - "type": "string", + "type": ["string", "null"], "description": "patron's encrypted password" }, "flags": { - "type": "string", + "type": ["string", "null"], "description": "a number associated with the patron's permissions" }, "userid": { - "type": "string", + "type": ["string", "null"], "description": "patron's login" }, "opacnote": { - "type": "string", + "type": ["string", "null"], "description": "a note on the patron's account visible in OPAC and staff client" }, "contactnote": { - "type": "string", + "type": ["string", "null"], "description": "a note related to patron's alternate address" }, "sort1": { - "type": "string", + "type": ["string", "null"], "description": "a field that can be used for any information unique to the library" }, "sort2": { - "type": "string", + "type": ["string", "null"], "description": "a field that can be used for any information unique to the library" }, "altcontactfirstname": { - "type": "string", + "type": ["string", "null"], "description": "first name of alternate contact for the patron" }, "altcontactsurname": { - "type": "string", + "type": ["string", "null"], "description": "surname or last name of the alternate contact for the patron" }, "altcontactaddress1": { - "type": "string", + "type": ["string", "null"], "description": "the first address line for the alternate contact for the patron" }, "altcontactaddress2": { - "type": "string", + "type": ["string", "null"], "description": "the second address line for the alternate contact for the patron" }, "altcontactaddress3": { - "type": "string", + "type": ["string", "null"], "description": "the city for the alternate contact for the patron" }, "altcontactstate": { - "type": "string", + "type": ["string", "null"], "description": "the state for the alternate contact for the patron" }, "altcontactzipcode": { - "type": "string", + "type": ["string", "null"], "description": "the zipcode for the alternate contact for the patron" }, "altcontactcountry": { - "type": "string", + "type": ["string", "null"], "description": "the country for the alternate contact for the patron" }, "altcontactphone": { - "type": "string", + "type": ["string", "null"], "description": "the phone number for the alternate contact for the patron" }, "smsalertnumber": { - "type": "string", + "type": ["string", "null"], "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)" }, "privacy": { -- 1.7.2.5