Browse Source

Bug 17006: OpenAPI spec

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
19.05.x
Tomás Cohen Arazi 4 years ago
committed by Nick Clemens
parent
commit
d4570947b0
  1. 3
      api/v1/swagger/paths.json
  2. 84
      api/v1/swagger/paths/patrons_password.json

3
api/v1/swagger/paths.json

@ -32,6 +32,9 @@
"/patrons/{patron_id}/account/credits": {
"$ref": "paths/patrons_account.json#/~1patrons~1{patron_id}~1account~1credits"
},
"/patrons/{patron_id}/password": {
"$ref": "paths/patrons_password.json#/~1patrons~1{patron_id}~1password"
},
"/illrequests": {
"$ref": "paths/illrequests.json#/~1illrequests"
},

84
api/v1/swagger/paths/patrons_password.json

@ -0,0 +1,84 @@
{
"/patrons/{patron_id}/password": {
"post": {
"x-mojo-to": "Patrons::Password#set",
"operationId": "setPatronPassword",
"tags": [
"patron"
],
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
},
{
"name": "body",
"in": "body",
"description": "A JSON object containing password information",
"schema": {
"type": "object",
"properties": {
"password": {
"description": "New password (plain text)",
"type": "string"
},
"password_2": {
"description": "Repeated new password (plain text)",
"type": "string"
}
},
"required": ["password", "password_2"]
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Password changed"
},
"400": {
"description": "Bad request",
"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"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"503": {
"description": "Under maintenance",
"schema": {
"$ref": "../definitions.json#/error"
}
}
},
"x-koha-authorization": {
"permissions": {
"borrowers": "1"
}
}
}
}
}
Loading…
Cancel
Save