Tomas Cohen Arazi
dd9b6c1651
This patch refactors the original work so it implements the controllers and the spec using Mojolicious::Plugin::OpenAPI, and OpenAPI for the specification. It removes the ability for patrons without permissions to edit their own data or their guarantee's. This will be moved to a patron modification requests endpoint for simplicity. It makes use of bugs 19410 and 19686 and their dependencies to deal with parameters handling, query building and pagination. Tests are adapted. To test: - Apply this patches and the dependencies - Run: $ kshell k$ prove t/db_dependent/api/v1/patrons.t => SUCCESS: Tests pass! - Sign off :-D Sponsored-by: ByWater Solutions Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> Signed-off-by: Josef Moravec <josef.moravec@gmail.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
748 lines
20 KiB
JSON
748 lines
20 KiB
JSON
{
|
|
"/patrons": {
|
|
"get": {
|
|
"x-mojo-to": "Patron#list",
|
|
"operationId": "listPatrons",
|
|
"tags": ["patrons"],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [{
|
|
"name": "borrowernumber",
|
|
"in": "query",
|
|
"description": "Case insensitive search on borrowernumber",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "cardnumber",
|
|
"in": "query",
|
|
"description": "Case insensitive search on cardnumber",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "surname",
|
|
"in": "query",
|
|
"description": "Case insensitive search on surname",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "firstname",
|
|
"in": "query",
|
|
"description": "Case insensitive search on firstname",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "title",
|
|
"in": "query",
|
|
"description": "Case insensitive search on title",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "othernames",
|
|
"in": "query",
|
|
"description": "Case insensitive search on othernames",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "initials",
|
|
"in": "query",
|
|
"description": "Case insensitive search on initials",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "streetnumber",
|
|
"in": "query",
|
|
"description": "Case insensitive search on streetnumber",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "streettype",
|
|
"in": "query",
|
|
"description": "Case insensitive search on streettype",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "address",
|
|
"in": "query",
|
|
"description": "Case insensitive search on address",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "address2",
|
|
"in": "query",
|
|
"description": "Case insensitive search on address2",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "city",
|
|
"in": "query",
|
|
"description": "Case insensitive search on city",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "state",
|
|
"in": "query",
|
|
"description": "Case insensitive search on state",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "zipcode",
|
|
"in": "query",
|
|
"description": "Case insensitive search on zipcode",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "country",
|
|
"in": "query",
|
|
"description": "Case insensitive search on country",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "email",
|
|
"in": "query",
|
|
"description": "Case insensitive search on email",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "phone",
|
|
"in": "query",
|
|
"description": "Case insensitive search on phone",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "mobile",
|
|
"in": "query",
|
|
"description": "Case insensitive search on mobile",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "fax",
|
|
"in": "query",
|
|
"description": "Case insensitive search on fax",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "emailpro",
|
|
"in": "query",
|
|
"description": "Case insensitive search on emailpro",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "phonepro",
|
|
"in": "query",
|
|
"description": "Case insensitive search on phonepro",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_streetnumber",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_streetnumber",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_streettype",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_streettype",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_address",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_address",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_address2",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_address2",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_city",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_city",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_state",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_state",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_zipcode",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_zipcode",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_country",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_country",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_email",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_email",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "B_phone",
|
|
"in": "query",
|
|
"description": "Case insensitive search on B_phone",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "dateofbirth",
|
|
"in": "query",
|
|
"description": "Case insensitive search on dateofbirth",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "branchcode",
|
|
"in": "query",
|
|
"description": "Case insensitive search on branchcode",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "categorycode",
|
|
"in": "query",
|
|
"description": "Case insensitive search on categorycode",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "dateenrolled",
|
|
"in": "query",
|
|
"description": "Case insensitive search on dateenrolled",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "dateexpiry",
|
|
"in": "query",
|
|
"description": "Case insensitive search on dateexpiry",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "gonenoaddress",
|
|
"in": "query",
|
|
"description": "Search on gonenoaddress",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}, {
|
|
"name": "lost",
|
|
"in": "query",
|
|
"description": "Search on lost",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}, {
|
|
"name": "debarred",
|
|
"in": "query",
|
|
"description": "Case insensitive search on debarred",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "debarredcomment",
|
|
"in": "query",
|
|
"description": "Case insensitive search on debarredcomment",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "contactname",
|
|
"in": "query",
|
|
"description": "Case insensitive search on contactname",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "contactfirstname",
|
|
"in": "query",
|
|
"description": "Case insensitive search on contactfirstname",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "contacttitle",
|
|
"in": "query",
|
|
"description": "Case insensitive search on contacttitle",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "guarantorid",
|
|
"in": "query",
|
|
"description": "Case insensitive search on guarantorid",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "borrowernotes",
|
|
"in": "query",
|
|
"description": "Case insensitive search on borrowernotes",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "relationship",
|
|
"in": "query",
|
|
"description": "Case insensitive search on relationship",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "sex",
|
|
"in": "query",
|
|
"description": "Case insensitive search on sex",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "password",
|
|
"in": "query",
|
|
"description": "Case insensitive search on password",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "flags",
|
|
"in": "query",
|
|
"description": "Case insensitive search on flags",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "userid",
|
|
"in": "query",
|
|
"description": "Case insensitive search on userid",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "opacnote",
|
|
"in": "query",
|
|
"description": "Case insensitive search on opacnote",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "contactnote",
|
|
"in": "query",
|
|
"description": "Case insensitive search on contactnote",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "sort1",
|
|
"in": "query",
|
|
"description": "Case insensitive search on sort1",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "sort2",
|
|
"in": "query",
|
|
"description": "Case insensitive search on sort2",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactfirstname",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactfirstname",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactsurname",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactsurname",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactaddress1",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactaddress1",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactaddress2",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactaddress2",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactaddress3",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactaddress3",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactstate",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactstate",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactzipcode",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactzipcode",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactcountry",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactcountry",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "altcontactphone",
|
|
"in": "query",
|
|
"description": "Case insensitive search on altcontactphone",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "smsalertnumber",
|
|
"in": "query",
|
|
"description": "Case insensitive search on smsalertnumber",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "sms_provider_id",
|
|
"in": "query",
|
|
"description": "Case insensitive search on sms_provider_id",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "privacy",
|
|
"in": "query",
|
|
"description": "Case insensitive search on privacy",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "privacy_guarantor_checkouts",
|
|
"in": "query",
|
|
"description": "Case insensitive search on privacy_guarantor_checkouts",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "checkprevcheckout",
|
|
"in": "query",
|
|
"description": "Case insensitive search on checkprevcheckout",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "updated_on",
|
|
"in": "query",
|
|
"description": "Case insensitive search on updated_on",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "lastseen",
|
|
"in": "query",
|
|
"description": "Case insensitive search on lastseen",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "lang",
|
|
"in": "query",
|
|
"description": "Case insensitive search on lang",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "login_attempts",
|
|
"in": "query",
|
|
"description": "Case insensitive search on login_attempts",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"name": "overdrive_auth_token",
|
|
"in": "query",
|
|
"description": "Case insensitive search on overdrive_auth_token",
|
|
"required": false,
|
|
"type": "string"
|
|
}, {
|
|
"$ref": "../parameters.json#/match"
|
|
}, {
|
|
"$ref": "../parameters.json#/order_by"
|
|
}, {
|
|
"$ref": "../parameters.json#/page"
|
|
}, {
|
|
"$ref": "../parameters.json#/per_page"
|
|
}],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of patrons",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "../definitions.json#/patron"
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
}
|
|
},
|
|
"x-koha-authorization": {
|
|
"permissions": {
|
|
"borrowers": "1"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"x-mojo-to": "Patron#add",
|
|
"operationId": "addPatron",
|
|
"tags": ["patrons"],
|
|
"parameters": [{
|
|
"name": "body",
|
|
"in": "body",
|
|
"description": "A JSON object containing information about the new patron",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "../definitions.json#/patron"
|
|
}
|
|
}],
|
|
"consumes": ["application/json"],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"201": {
|
|
"description": "A successfully created patron",
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "../definitions.json#/patron"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad parameter",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Resource not found",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict in creating resource",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"503": {
|
|
"description": "Under maintenance",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
}
|
|
},
|
|
"x-koha-authorization": {
|
|
"permissions": {
|
|
"borrowers": "edit_borrowers"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/patrons/{borrowernumber}": {
|
|
"get": {
|
|
"x-mojo-to": "Patron#get",
|
|
"operationId": "getPatron",
|
|
"tags": ["patrons"],
|
|
"parameters": [{
|
|
"$ref": "../parameters.json#/borrowernumberPathParam"
|
|
}],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A patron",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/patron"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Patron not found",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"503": {
|
|
"description": "Under maintenance",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
}
|
|
},
|
|
"x-koha-authorization": {
|
|
"allow-owner": true,
|
|
"allow-guarantor": true,
|
|
"permissions": {
|
|
"borrowers": "edit_borrowers"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"x-mojo-to": "Patron#update",
|
|
"operationId": "updatePatron",
|
|
"tags": ["patrons"],
|
|
"parameters": [
|
|
{
|
|
"$ref": "../parameters.json#/borrowernumberPathParam"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"description": "A JSON object containing new information about existing patron",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "../definitions.json#/patron"
|
|
}
|
|
}
|
|
],
|
|
"consumes": ["application/json"],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successfully updated patron",
|
|
"schema": {
|
|
"items": {
|
|
"$ref": "../definitions.json#/patron"
|
|
}
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "Accepted and waiting for librarian verification",
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"204": {
|
|
"description": "No Content",
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad parameter",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Resource not found",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict in updating resource",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
}
|
|
},
|
|
"x-koha-authorization": {
|
|
"permissions": {
|
|
"borrowers": "1"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"x-mojo-to": "Patron#delete",
|
|
"operationId": "deletePatron",
|
|
"tags": ["patrons"],
|
|
"parameters": [{
|
|
"$ref": "../parameters.json#/borrowernumberPathParam"
|
|
}],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Patron deleted successfully",
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Patron deletion failed",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Patron not found",
|
|
"schema": {
|
|
"$ref": "../definitions.json#/error"
|
|
}
|
|
}
|
|
},
|
|
"x-koha-authorization": {
|
|
"permissions": {
|
|
"borrowers": "1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|