Bugzilla – Attachment 52959 Details for
Bug 16699
Swagger: Split parameters and paths, and specify required permissions for resource
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
[SIGNED-OFF] Bug 16699: Fix mixed-up indentation from 2-4 spaces to 2 spaces
SIGNED-OFF-Bug-16699-Fix-mixed-up-indentation-from.patch (text/plain), 24.21 KB, created by
Olli-Antti Kivilahti
on 2016-06-30 11:23:51 UTC
(
hide
)
Description:
[SIGNED-OFF] Bug 16699: Fix mixed-up indentation from 2-4 spaces to 2 spaces
Filename:
MIME Type:
Creator:
Olli-Antti Kivilahti
Created:
2016-06-30 11:23:51 UTC
Size:
24.21 KB
patch
obsolete
>From 158dc9561dbc11485c8a4a11571bb8314995ed19 Mon Sep 17 00:00:00 2001 >From: Lari Taskula <larit@student.uef.fi> >Date: Fri, 10 Jun 2016 17:25:40 +0300 >Subject: [PATCH] [SIGNED-OFF] Bug 16699: Fix mixed-up indentation from 2-4 > spaces to 2 spaces > >These definitions had indentation of 4 spaces, while rest of the specification >uses 2 spaces. This patch simply maintains the consistency in indentations and >provides no other modifications to code. > >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. >--- > api/v1/definitions/hold.json | 120 ++++----- > api/v1/definitions/holds.json | 6 +- > api/v1/definitions/patron.json | 542 ++++++++++++++++++++--------------------- > 3 files changed, 335 insertions(+), 333 deletions(-) > >diff --git a/api/v1/definitions/hold.json b/api/v1/definitions/hold.json >index 17bc834..d060810 100644 >--- a/api/v1/definitions/hold.json >+++ b/api/v1/definitions/hold.json >@@ -1,63 +1,63 @@ > { >- "type": "object", >- "properties": { >- "reserve_id": { >- "description": "Internal hold identifier" >- }, >- "borrowernumber": { >- "type": "string", >- "description": "internally assigned user identifier" >- }, >- "reservedate": { >- "description": "the date the hold was placed" >- }, >- "biblionumber": { >- "type": "string", >- "description": "internally assigned biblio identifier" >- }, >- "branchcode": { >- "type": ["string", "null"], >- "description": "internally assigned branch identifier" >- }, >- "notificationdate": { >- "description": "currently unused" >- }, >- "reminderdate": { >- "description": "currently unused" >- }, >- "cancellationdate": { >- "description": "the date the hold was cancelled" >- }, >- "reservenotes": { >- "description": "notes related to this hold" >- }, >- "priority": { >- "description": "where in the queue the patron sits" >- }, >- "found": { >- "description": "a one letter code defining what the status of the hold is after it has been confirmed" >- }, >- "timestamp": { >- "description": "date and time the hold was last updated" >- }, >- "itemnumber": { >- "type": ["string", "null"], >- "description": "internally assigned item identifier" >- }, >- "waitingdate": { >- "description": "the date the item was marked as waiting for the patron at the library" >- }, >- "expirationdate": { >- "description": "the date the hold expires" >- }, >- "lowestPriority": { >- "description": "" >- }, >- "suspend": { >- "description": "" >- }, >- "suspend_until": { >- "description": "" >- } >+ "type": "object", >+ "properties": { >+ "reserve_id": { >+ "description": "Internal hold identifier" >+ }, >+ "borrowernumber": { >+ "type": "string", >+ "description": "internally assigned user identifier" >+ }, >+ "reservedate": { >+ "description": "the date the hold was placed" >+ }, >+ "biblionumber": { >+ "type": "string", >+ "description": "internally assigned biblio identifier" >+ }, >+ "branchcode": { >+ "type": ["string", "null"], >+ "description": "internally assigned branch identifier" >+ }, >+ "notificationdate": { >+ "description": "currently unused" >+ }, >+ "reminderdate": { >+ "description": "currently unused" >+ }, >+ "cancellationdate": { >+ "description": "the date the hold was cancelled" >+ }, >+ "reservenotes": { >+ "description": "notes related to this hold" >+ }, >+ "priority": { >+ "description": "where in the queue the patron sits" >+ }, >+ "found": { >+ "description": "a one letter code defining what the status of the hold is after it has been confirmed" >+ }, >+ "timestamp": { >+ "description": "date and time the hold was last updated" >+ }, >+ "itemnumber": { >+ "type": ["string", "null"], >+ "description": "internally assigned item identifier" >+ }, >+ "waitingdate": { >+ "description": "the date the item was marked as waiting for the patron at the library" >+ }, >+ "expirationdate": { >+ "description": "the date the hold expires" >+ }, >+ "lowestPriority": { >+ "description": "" >+ }, >+ "suspend": { >+ "description": "" >+ }, >+ "suspend_until": { >+ "description": "" > } >+ } > } >diff --git a/api/v1/definitions/holds.json b/api/v1/definitions/holds.json >index 6d64441..e551885 100644 >--- a/api/v1/definitions/holds.json >+++ b/api/v1/definitions/holds.json >@@ -1,4 +1,6 @@ > { >- "type": "array", >- "items": { "$ref": "hold.json" } >+ "type": "array", >+ "items": { >+ "$ref": "hold.json" >+ } > } >diff --git a/api/v1/definitions/patron.json b/api/v1/definitions/patron.json >index fbee169..c5d8ff6 100644 >--- a/api/v1/definitions/patron.json >+++ b/api/v1/definitions/patron.json >@@ -1,273 +1,273 @@ > { >- "type": "object", >- "properties": { >- "borrowernumber": { >- "type": "string", >- "description": "internally assigned user identifier" >- }, >- "cardnumber": { >- "type": ["string", "null"], >- "description": "library assigned user identifier" >- }, >- "surname": { >- "type": "string", >- "description": "patron's last name" >- }, >- "firstname": { >- "type": ["string", "null"], >- "description": "patron's first name" >- }, >- "title": { >- "type": ["string", "null"], >- "description": "patron's title" >- }, >- "othernames": { >- "type": ["string", "null"], >- "description": "any other names associated with the patron" >- }, >- "initials": { >- "type": ["string", "null"], >- "description": "initials of the patron" >- }, >- "streetnumber": { >- "type": ["string", "null"], >- "description": "street number of patron's primary address" >- }, >- "streettype": { >- "type": ["string", "null"], >- "description": "street type of patron's primary address" >- }, >- "address": { >- "type": "string", >- "description": "first address line of patron's primary address" >- }, >- "address2": { >- "type": ["string", "null"], >- "description": "second address line of patron's primary address" >- }, >- "city": { >- "type": "string", >- "description": "city or town of patron's primary address" >- }, >- "state": { >- "type": ["string", "null"], >- "description": "state or province of patron's primary address" >- }, >- "zipcode": { >- "type": ["string", "null"], >- "description": "zip or postal code of patron's primary address" >- }, >- "country": { >- "type": ["string", "null"], >- "description": "country of patron's primary address" >- }, >- "email": { >- "type": ["string", "null"], >- "description": "primary email address for patron's primary address" >- }, >- "phone": { >- "type": ["string", "null"], >- "description": "primary phone number for patron's primary address" >- }, >- "mobile": { >- "type": ["string", "null"], >- "description": "the other phone number for patron's primary address" >- }, >- "fax": { >- "type": ["string", "null"], >- "description": "fax number for patron's primary address" >- }, >- "emailpro": { >- "type": ["string", "null"], >- "description": "secondary email address for patron's primary address" >- }, >- "phonepro": { >- "type": ["string", "null"], >- "description": "secondary phone number for patron's primary address" >- }, >- "B_streetnumber": { >- "type": ["string", "null"], >- "description": "street number of patron's alternate address" >- }, >- "B_streettype": { >- "type": ["string", "null"], >- "description": "street type of patron's alternate address" >- }, >- "B_address": { >- "type": ["string", "null"], >- "description": "first address line of patron's alternate address" >- }, >- "B_address2": { >- "type": ["string", "null"], >- "description": "second address line of patron's alternate address" >- }, >- "B_city": { >- "type": ["string", "null"], >- "description": "city or town of patron's alternate address" >- }, >- "B_state": { >- "type": ["string", "null"], >- "description": "state or province of patron's alternate address" >- }, >- "B_zipcode": { >- "type": ["string", "null"], >- "description": "zip or postal code of patron's alternate address" >- }, >- "B_country": { >- "type": ["string", "null"], >- "description": "country of patron's alternate address" >- }, >- "B_email": { >- "type": ["string", "null"], >- "description": "email address for patron's alternate address" >- }, >- "B_phone": { >- "type": ["string", "null"], >- "description": "phone number for patron's alternate address" >- }, >- "dateofbirth": { >- "type": ["string", "null"], >- "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", "null"], >- "description": "date the patron was added to Koha" >- }, >- "dateexpiry": { >- "type": ["string", "null"], >- "description": "date the patron's card is set to expire" >- }, >- "gonenoaddress": { >- "type": ["string", "null"], >- "description": "set to 1 if library marked this patron as having an unconfirmed address" >- }, >- "lost": { >- "type": ["string", "null"], >- "description": "set to 1 if library marked this patron as having lost his card" >- }, >- "debarred": { >- "type": ["string", "null"], >- "description": "until this date the patron can only check-in" >- }, >- "debarredcomment": { >- "type": ["string", "null"], >- "description": "comment on the stop of the patron" >- }, >- "contactname": { >- "type": ["string", "null"], >- "description": "used for children and professionals to include surname or last name of guarantor or organization name" >- }, >- "contactfirstname": { >- "type": ["string", "null"], >- "description": "used for children to include first name of guarantor" >- }, >- "contacttitle": { >- "type": ["string", "null"], >- "description": "used for children to include title of guarantor" >- }, >- "guarantorid": { >- "type": ["string", "null"], >- "description": "borrowernumber used for children or professionals to link them to guarantor or organizations" >- }, >- "borrowernotes": { >- "type": ["string", "null"], >- "description": "a note on the patron's account" >- }, >- "relationship": { >- "type": ["string", "null"], >- "description": "used for children to include the relationship to their guarantor" >- }, >- "sex": { >- "type": ["string", "null"], >- "description": "patron's gender" >- }, >- "password": { >- "type": ["string", "null"], >- "description": "patron's encrypted password" >- }, >- "flags": { >- "type": ["string", "null"], >- "description": "a number associated with the patron's permissions" >- }, >- "userid": { >- "type": ["string", "null"], >- "description": "patron's login" >- }, >- "opacnote": { >- "type": ["string", "null"], >- "description": "a note on the patron's account visible in OPAC and staff client" >- }, >- "contactnote": { >- "type": ["string", "null"], >- "description": "a note related to patron's alternate address" >- }, >- "sort1": { >- "type": ["string", "null"], >- "description": "a field that can be used for any information unique to the library" >- }, >- "sort2": { >- "type": ["string", "null"], >- "description": "a field that can be used for any information unique to the library" >- }, >- "altcontactfirstname": { >- "type": ["string", "null"], >- "description": "first name of alternate contact for the patron" >- }, >- "altcontactsurname": { >- "type": ["string", "null"], >- "description": "surname or last name of the alternate contact for the patron" >- }, >- "altcontactaddress1": { >- "type": ["string", "null"], >- "description": "the first address line for the alternate contact for the patron" >- }, >- "altcontactaddress2": { >- "type": ["string", "null"], >- "description": "the second address line for the alternate contact for the patron" >- }, >- "altcontactaddress3": { >- "type": ["string", "null"], >- "description": "the city for the alternate contact for the patron" >- }, >- "altcontactstate": { >- "type": ["string", "null"], >- "description": "the state for the alternate contact for the patron" >- }, >- "altcontactzipcode": { >- "type": ["string", "null"], >- "description": "the zipcode for the alternate contact for the patron" >- }, >- "altcontactcountry": { >- "type": ["string", "null"], >- "description": "the country for the alternate contact for the patron" >- }, >- "altcontactphone": { >- "type": ["string", "null"], >- "description": "the phone number for the alternate contact for the patron" >- }, >- "smsalertnumber": { >- "type": ["string", "null"], >- "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)" >- }, >- "sms_provider_id": { >- "type": ["string", "null"], >- "description": "the provider of the mobile phone number defined in smsalertnumber" >- }, >- "privacy": { >- "type": "string", >- "description": "patron's privacy settings related to their reading history" >- }, >- "privacy_guarantor_checkouts": { >- "type": "string", >- "description": "controls if relatives can see this patron's checkouts" >- } >- } >+ "type": "object", >+ "properties": { >+ "borrowernumber": { >+ "type": "string", >+ "description": "internally assigned user identifier" >+ }, >+ "cardnumber": { >+ "type": ["string", "null"], >+ "description": "library assigned user identifier" >+ }, >+ "surname": { >+ "type": "string", >+ "description": "patron's last name" >+ }, >+ "firstname": { >+ "type": ["string", "null"], >+ "description": "patron's first name" >+ }, >+ "title": { >+ "type": ["string", "null"], >+ "description": "patron's title" >+ }, >+ "othernames": { >+ "type": ["string", "null"], >+ "description": "any other names associated with the patron" >+ }, >+ "initials": { >+ "type": ["string", "null"], >+ "description": "initials of the patron" >+ }, >+ "streetnumber": { >+ "type": ["string", "null"], >+ "description": "street number of patron's primary address" >+ }, >+ "streettype": { >+ "type": ["string", "null"], >+ "description": "street type of patron's primary address" >+ }, >+ "address": { >+ "type": "string", >+ "description": "first address line of patron's primary address" >+ }, >+ "address2": { >+ "type": ["string", "null"], >+ "description": "second address line of patron's primary address" >+ }, >+ "city": { >+ "type": "string", >+ "description": "city or town of patron's primary address" >+ }, >+ "state": { >+ "type": ["string", "null"], >+ "description": "state or province of patron's primary address" >+ }, >+ "zipcode": { >+ "type": ["string", "null"], >+ "description": "zip or postal code of patron's primary address" >+ }, >+ "country": { >+ "type": ["string", "null"], >+ "description": "country of patron's primary address" >+ }, >+ "email": { >+ "type": ["string", "null"], >+ "description": "primary email address for patron's primary address" >+ }, >+ "phone": { >+ "type": ["string", "null"], >+ "description": "primary phone number for patron's primary address" >+ }, >+ "mobile": { >+ "type": ["string", "null"], >+ "description": "the other phone number for patron's primary address" >+ }, >+ "fax": { >+ "type": ["string", "null"], >+ "description": "fax number for patron's primary address" >+ }, >+ "emailpro": { >+ "type": ["string", "null"], >+ "description": "secondary email address for patron's primary address" >+ }, >+ "phonepro": { >+ "type": ["string", "null"], >+ "description": "secondary phone number for patron's primary address" >+ }, >+ "B_streetnumber": { >+ "type": ["string", "null"], >+ "description": "street number of patron's alternate address" >+ }, >+ "B_streettype": { >+ "type": ["string", "null"], >+ "description": "street type of patron's alternate address" >+ }, >+ "B_address": { >+ "type": ["string", "null"], >+ "description": "first address line of patron's alternate address" >+ }, >+ "B_address2": { >+ "type": ["string", "null"], >+ "description": "second address line of patron's alternate address" >+ }, >+ "B_city": { >+ "type": ["string", "null"], >+ "description": "city or town of patron's alternate address" >+ }, >+ "B_state": { >+ "type": ["string", "null"], >+ "description": "state or province of patron's alternate address" >+ }, >+ "B_zipcode": { >+ "type": ["string", "null"], >+ "description": "zip or postal code of patron's alternate address" >+ }, >+ "B_country": { >+ "type": ["string", "null"], >+ "description": "country of patron's alternate address" >+ }, >+ "B_email": { >+ "type": ["string", "null"], >+ "description": "email address for patron's alternate address" >+ }, >+ "B_phone": { >+ "type": ["string", "null"], >+ "description": "phone number for patron's alternate address" >+ }, >+ "dateofbirth": { >+ "type": ["string", "null"], >+ "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", "null"], >+ "description": "date the patron was added to Koha" >+ }, >+ "dateexpiry": { >+ "type": ["string", "null"], >+ "description": "date the patron's card is set to expire" >+ }, >+ "gonenoaddress": { >+ "type": ["string", "null"], >+ "description": "set to 1 if library marked this patron as having an unconfirmed address" >+ }, >+ "lost": { >+ "type": ["string", "null"], >+ "description": "set to 1 if library marked this patron as having lost his card" >+ }, >+ "debarred": { >+ "type": ["string", "null"], >+ "description": "until this date the patron can only check-in" >+ }, >+ "debarredcomment": { >+ "type": ["string", "null"], >+ "description": "comment on the stop of the patron" >+ }, >+ "contactname": { >+ "type": ["string", "null"], >+ "description": "used for children and professionals to include surname or last name of guarantor or organization name" >+ }, >+ "contactfirstname": { >+ "type": ["string", "null"], >+ "description": "used for children to include first name of guarantor" >+ }, >+ "contacttitle": { >+ "type": ["string", "null"], >+ "description": "used for children to include title of guarantor" >+ }, >+ "guarantorid": { >+ "type": ["string", "null"], >+ "description": "borrowernumber used for children or professionals to link them to guarantor or organizations" >+ }, >+ "borrowernotes": { >+ "type": ["string", "null"], >+ "description": "a note on the patron's account" >+ }, >+ "relationship": { >+ "type": ["string", "null"], >+ "description": "used for children to include the relationship to their guarantor" >+ }, >+ "sex": { >+ "type": ["string", "null"], >+ "description": "patron's gender" >+ }, >+ "password": { >+ "type": ["string", "null"], >+ "description": "patron's encrypted password" >+ }, >+ "flags": { >+ "type": ["string", "null"], >+ "description": "a number associated with the patron's permissions" >+ }, >+ "userid": { >+ "type": ["string", "null"], >+ "description": "patron's login" >+ }, >+ "opacnote": { >+ "type": ["string", "null"], >+ "description": "a note on the patron's account visible in OPAC and staff client" >+ }, >+ "contactnote": { >+ "type": ["string", "null"], >+ "description": "a note related to patron's alternate address" >+ }, >+ "sort1": { >+ "type": ["string", "null"], >+ "description": "a field that can be used for any information unique to the library" >+ }, >+ "sort2": { >+ "type": ["string", "null"], >+ "description": "a field that can be used for any information unique to the library" >+ }, >+ "altcontactfirstname": { >+ "type": ["string", "null"], >+ "description": "first name of alternate contact for the patron" >+ }, >+ "altcontactsurname": { >+ "type": ["string", "null"], >+ "description": "surname or last name of the alternate contact for the patron" >+ }, >+ "altcontactaddress1": { >+ "type": ["string", "null"], >+ "description": "the first address line for the alternate contact for the patron" >+ }, >+ "altcontactaddress2": { >+ "type": ["string", "null"], >+ "description": "the second address line for the alternate contact for the patron" >+ }, >+ "altcontactaddress3": { >+ "type": ["string", "null"], >+ "description": "the city for the alternate contact for the patron" >+ }, >+ "altcontactstate": { >+ "type": ["string", "null"], >+ "description": "the state for the alternate contact for the patron" >+ }, >+ "altcontactzipcode": { >+ "type": ["string", "null"], >+ "description": "the zipcode for the alternate contact for the patron" >+ }, >+ "altcontactcountry": { >+ "type": ["string", "null"], >+ "description": "the country for the alternate contact for the patron" >+ }, >+ "altcontactphone": { >+ "type": ["string", "null"], >+ "description": "the phone number for the alternate contact for the patron" >+ }, >+ "smsalertnumber": { >+ "type": ["string", "null"], >+ "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)" >+ }, >+ "sms_provider_id": { >+ "type": ["string", "null"], >+ "description": "the provider of the mobile phone number defined in smsalertnumber" >+ }, >+ "privacy": { >+ "type": "string", >+ "description": "patron's privacy settings related to their reading history" >+ }, >+ "privacy_guarantor_checkouts": { >+ "type": "string", >+ "description": "controls if relatives can see this patron's checkouts" >+ } >+ } > } >-- >1.9.1
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
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