Browse Source

Bug 28463: Add summary to all routes

This patch adds a 'summary' entry to all routes and verbs. This way,
ReDoc will display a human-friendly description of the route, instead of
the operationId.

To test, repeat the testing steps in the previous patch, and notice that
we now have good descriptions.

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

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

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
tags/v21.05.00
Tomas Cohen Arazi 2 weeks ago
parent
commit
748b2e91a3
25 changed files with 230 additions and 114 deletions
  1. +1
    -0
      api/v1/swagger/paths/acquisitions_funds.json
  2. +5
    -0
      api/v1/swagger/paths/acquisitions_orders.json
  3. +5
    -0
      api/v1/swagger/paths/acquisitions_vendors.json
  4. +18
    -9
      api/v1/swagger/paths/advancededitormacros.json
  5. +7
    -6
      api/v1/swagger/paths/biblios.json
  6. +2
    -0
      api/v1/swagger/paths/cash_registers.json
  7. +4
    -0
      api/v1/swagger/paths/checkouts.json
  8. +5
    -0
      api/v1/swagger/paths/cities.json
  9. +125
    -99
      api/v1/swagger/paths/clubs.json
  10. +5
    -0
      api/v1/swagger/paths/config_smtp_servers.json
  11. +11
    -0
      api/v1/swagger/paths/holds.json
  12. +2
    -0
      api/v1/swagger/paths/ill_backends.json
  13. +1
    -0
      api/v1/swagger/paths/illrequests.json
  14. +4
    -0
      api/v1/swagger/paths/import_batch_profiles.json
  15. +2
    -0
      api/v1/swagger/paths/items.json
  16. +5
    -0
      api/v1/swagger/paths/libraries.json
  17. +1
    -0
      api/v1/swagger/paths/oauth.json
  18. +5
    -0
      api/v1/swagger/paths/patrons.json
  19. +2
    -0
      api/v1/swagger/paths/patrons_account.json
  20. +5
    -0
      api/v1/swagger/paths/patrons_extended_attributes.json
  21. +1
    -0
      api/v1/swagger/paths/patrons_holds.json
  22. +1
    -0
      api/v1/swagger/paths/patrons_password.json
  23. +3
    -0
      api/v1/swagger/paths/public_patrons.json
  24. +5
    -0
      api/v1/swagger/paths/quotes.json
  25. +5
    -0
      api/v1/swagger/paths/transfer_limits.yaml

+ 1
- 0
api/v1/swagger/paths/acquisitions_funds.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Acquisitions::Funds#list",
"operationId": "listFunds",
"tags": ["funds"],
"summary": "List funds",
"produces": [
"application/json"
],


+ 5
- 0
api/v1/swagger/paths/acquisitions_orders.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Acquisitions::Orders#list",
"operationId": "listOrders",
"tags": ["orders"],
"summary": "List orders",
"produces": [
"application/json"
],
@@ -131,6 +132,7 @@
"x-mojo-to": "Acquisitions::Orders#add",
"operationId": "addOrder",
"tags": ["orders"],
"summary": "Add order",
"parameters": [
{
"name": "body",
@@ -201,6 +203,7 @@
"x-mojo-to": "Acquisitions::Orders#get",
"operationId": "getOrder",
"tags": ["orders"],
"summary": "Get order",
"parameters": [
{
"$ref": "../parameters.json#/order_id_pp"
@@ -272,6 +275,7 @@
"x-mojo-to": "Acquisitions::Orders#update",
"operationId": "updateOrder",
"tags": ["orders"],
"summary": "Update order",
"parameters": [
{
"$ref": "../parameters.json#/order_id_pp"
@@ -337,6 +341,7 @@
"x-mojo-to": "Acquisitions::Orders#delete",
"operationId": "deleteOrder",
"tags": ["orders"],
"summary": "Delete order",
"parameters": [
{
"$ref": "../parameters.json#/order_id_pp"


+ 5
- 0
api/v1/swagger/paths/acquisitions_vendors.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Acquisitions::Vendors#list",
"operationId": "listVendors",
"tags": ["vendors"],
"summary": "List vendors",
"produces": [
"application/json"
],
@@ -79,6 +80,7 @@
"x-mojo-to": "Acquisitions::Vendors#add",
"operationId": "addVendor",
"tags": ["vendors"],
"summary": "Add vendor",
"parameters": [{
"name": "body",
"in": "body",
@@ -141,6 +143,7 @@
"x-mojo-to": "Acquisitions::Vendors#get",
"operationId": "getVendor",
"tags": ["vendors"],
"summary": "Get vendor",
"parameters": [{
"$ref": "../parameters.json#/vendoridPathParam"
}],
@@ -195,6 +198,7 @@
"x-mojo-to": "Acquisitions::Vendors#update",
"operationId": "updateVendor",
"tags": ["vendors"],
"summary": "Update vendor",
"parameters": [{
"$ref": "../parameters.json#/vendoridPathParam"
}, {
@@ -257,6 +261,7 @@
"x-mojo-to": "Acquisitions::Vendors#delete",
"operationId": "deleteVendor",
"tags": ["vendors"],
"summary": "Delete vendor",
"parameters": [{
"$ref": "../parameters.json#/vendoridPathParam"
}],


+ 18
- 9
api/v1/swagger/paths/advancededitormacros.json View File

@@ -3,7 +3,8 @@
"get": {
"x-mojo-to": "AdvancedEditorMacro#list",
"operationId": "listMacro",
"tags": ["advancededitormacro"],
"tags": ["macros"],
"summary": "List advanced editor macros",
"produces": [
"application/json"
],
@@ -75,7 +76,8 @@
"post": {
"x-mojo-to": "AdvancedEditorMacro#add",
"operationId": "addAdvancedEditorMacro",
"tags": ["advancededitormacro"],
"tags": ["macros"],
"summary": "Add advanced editor macros",
"parameters": [{
"name": "body",
"in": "body",
@@ -131,7 +133,8 @@
"post": {
"x-mojo-to": "AdvancedEditorMacro#add_shared",
"operationId": "addsharedAdvancedEditorMacro",
"tags": ["advancededitormacro"],
"tags": ["macros"],
"summary": "Add shared advanced editor macros",
"parameters": [{
"name": "body",
"in": "body",
@@ -190,7 +193,8 @@
"get": {
"x-mojo-to": "AdvancedEditorMacro#get",
"operationId": "getAdvancedEditorMacro",
"tags": ["advancededitormacros"],
"tags": ["macros"],
"summary": "Get advanced editor macro",
"parameters": [{
"$ref": "../parameters.json#/advancededitormacro_id_pp"
}],
@@ -238,7 +242,8 @@
"put": {
"x-mojo-to": "AdvancedEditorMacro#update",
"operationId": "updateAdvancedEditorMacro",
"tags": ["advancededitormacros"],
"tags": ["macros"],
"summary": "Update advanced editor macro",
"parameters": [{
"$ref": "../parameters.json#/advancededitormacro_id_pp"
}, {
@@ -300,7 +305,8 @@
"delete": {
"x-mojo-to": "AdvancedEditorMacro#delete",
"operationId": "deleteAdvancedEditorMacro",
"tags": ["advancededitormacros"],
"tags": ["macros"],
"summary": "Delete advanced editor macro",
"parameters": [{
"$ref": "../parameters.json#/advancededitormacro_id_pp"
}],
@@ -356,7 +362,8 @@
"get": {
"x-mojo-to": "AdvancedEditorMacro#get_shared",
"operationId": "getsharedAdvancedEditorMacro",
"tags": ["advancededitormacros"],
"tags": ["macros"],
"summary": "Get shared advanced editor macro",
"parameters": [{
"$ref": "../parameters.json#/advancededitormacro_id_pp"
}],
@@ -404,7 +411,8 @@
"put": {
"x-mojo-to": "AdvancedEditorMacro#update_shared",
"operationId": "updatesharedAdvancedEditorMacro",
"tags": ["advancededitormacros"],
"tags": ["macros"],
"summary": "Update shared advanced editor macro",
"parameters": [{
"$ref": "../parameters.json#/advancededitormacro_id_pp"
}, {
@@ -469,7 +477,8 @@
"delete": {
"x-mojo-to": "AdvancedEditorMacro#delete_shared",
"operationId": "deletesharedAdvancedEditorMacro",
"tags": ["advancededitormacros"],
"tags": ["macros"],
"summary": "Delete shared advanced editor macro",
"parameters": [{
"$ref": "../parameters.json#/advancededitormacro_id_pp"
}],


+ 7
- 6
api/v1/swagger/paths/biblios.json View File

@@ -3,9 +3,8 @@
"get": {
"x-mojo-to": "Biblios#get",
"operationId": "getBiblio",
"tags": [
"biblios"
],
"tags": [ "biblios" ],
"summary": "Get biblio",
"parameters": [
{
"$ref": "../parameters.json#/biblio_id_pp"
@@ -72,9 +71,8 @@
"delete": {
"x-mojo-to": "Biblios#delete",
"operationId": "deleteBiblio",
"tags": [
"biblios"
],
"tags": [ "biblios" ],
"summary": "Delete biblio",
"parameters": [
{
"$ref": "../parameters.json#/biblio_id_pp"
@@ -141,6 +139,7 @@
"tags": [
"biblios"
],
"summary": "Get items for a biblio",
"parameters": [
{
"$ref": "../parameters.json#/biblio_id_pp"
@@ -238,6 +237,7 @@
"tags": [
"biblios"
],
"summary": "Get valid pickup locations for a biblio",
"parameters": [
{
"$ref": "../parameters.json#/biblio_id_pp"
@@ -338,6 +338,7 @@
"tags": [
"biblios"
],
"summary": "Get biblio (public)",
"parameters": [
{
"$ref": "../parameters.json#/biblio_id_pp"


+ 2
- 0
api/v1/swagger/paths/cash_registers.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "CashRegisters::Cashups#list",
"operationId": "listCashups",
"tags": ["cashups"],
"summary": "List cashups for the cash register",
"produces": ["application/json"],
"parameters": [{
"$ref": "../parameters.json#/cash_register_id_pp"
@@ -68,6 +69,7 @@
"x-mojo-to": "CashRegisters::Cashups#get",
"operationId": "getCashup",
"tags": ["cashups"],
"summary": "Get cashup",
"parameters": [{
"$ref": "../parameters.json#/cashup_id_pp"
}],


+ 4
- 0
api/v1/swagger/paths/checkouts.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Checkouts#list",
"operationId": "listCheckouts",
"tags": ["checkouts"],
"summary": "List checkouts",
"parameters": [{
"$ref": "../parameters.json#/patron_id_qp"
}, {
@@ -54,6 +55,7 @@
"x-mojo-to": "Checkouts#get",
"operationId": "getCheckout",
"tags": ["checkouts"],
"summary": "Get checkout",
"parameters": [{
"$ref": "../parameters.json#/checkout_id_pp"
}],
@@ -87,6 +89,7 @@
"x-mojo-to": "Checkouts#renew",
"operationId": "renewCheckout",
"tags": ["checkouts"],
"summary": "Renew a checkout",
"parameters": [
{ "$ref": "../parameters.json#/checkout_id_pp" },
{ "$ref": "../parameters.json#/seen_pp" }
@@ -118,6 +121,7 @@
"x-mojo-to": "Checkouts#allows_renewal",
"operationId": "allows_renewalCheckout",
"tags": ["checkouts"],
"summary": "Get renewability for a checkout",
"parameters": [{
"$ref": "../parameters.json#/checkout_id_pp"
}],


+ 5
- 0
api/v1/swagger/paths/cities.json View File

@@ -6,6 +6,7 @@
"tags": [
"cities"
],
"summary": "List cities",
"produces": [
"application/json"
],
@@ -101,6 +102,7 @@
"tags": [
"cities"
],
"summary": "Add city",
"parameters": [
{
"name": "body",
@@ -161,6 +163,7 @@
"tags": [
"cities"
],
"summary": "Get city",
"parameters": [
{
"$ref": "../parameters.json#/city_id_pp"
@@ -207,6 +210,7 @@
"tags": [
"cities"
],
"summary": "Update city",
"parameters": [
{
"$ref": "../parameters.json#/city_id_pp"
@@ -274,6 +278,7 @@
"tags": [
"cities"
],
"summary": "Delete city",
"parameters": [
{
"$ref": "../parameters.json#/city_id_pp"


+ 125
- 99
api/v1/swagger/paths/clubs.json View File

@@ -1,111 +1,137 @@
{
"/clubs/{club_id}/holds": {
"post": {
"x-mojo-to": "Clubs::Holds#add",
"operationId": "addClubHold",
"tags": ["clubs"],
"parameters": [{
"$ref": "../parameters.json#/club_id_pp"
}, {
"name": "body",
"in": "body",
"description": "A JSON object containing informations about the new hold",
"required": true,
"schema": {
"type": "object",
"properties": {
"biblio_id": {
"description": "Internal biblio identifier",
"type": [ "integer", "null" ]
},
"item_id": {
"description": "Internal item identifier",
"type": [ "integer", "null" ]
},
"pickup_library_id": {
"description": "Internal library identifier for the pickup library",
"type": "string"
},
"expiration_date": {
"description": "Hold end date",
"type": ["string", "null"],
"format": "date"
},
"notes": {
"description": "Notes related to this hold",
"type": [ "string", "null" ]
},
"item_type": {
"description": "Limit hold on one itemtype (ignored for item-level holds)",
"type": [ "string", "null" ]
},
"default_patron_home": {
"description": "For each patron, set pickup location to patron's home library if possible",
"type": "integer"
}
},
"required": [ "pickup_library_id" ],
"additionalProperties": false
}
}
],
"consumes": ["application/json"],
"produces": ["application/json"],
"responses": {
"201": {
"description": "Created hold",
"schema": {
"$ref": "../definitions/club_hold.json"
}
"/clubs/{club_id}/holds": {
"post": {
"x-mojo-to": "Clubs::Holds#add",
"operationId": "addClubHold",
"tags": [
"clubs"
],
"summary": "Add a club hold",
"parameters": [
{
"$ref": "../parameters.json#/club_id_pp"
},
{
"name": "body",
"in": "body",
"description": "A JSON object containing informations about the new hold",
"required": true,
"schema": {
"type": "object",
"properties": {
"biblio_id": {
"description": "Internal biblio identifier",
"type": [
"integer",
"null"
]
},
"400": {
"description": "Missing or wrong parameters",
"schema": {
"$ref": "../definitions.json#/error"
}
"item_id": {
"description": "Internal item identifier",
"type": [
"integer",
"null"
]
},
"401": {
"description": "Authentication required",
"schema": {
"$ref": "../definitions.json#/error"
}
"pickup_library_id": {
"description": "Internal library identifier for the pickup library",
"type": "string"
},
"403": {
"description": "Hold not allowed",
"schema": {
"$ref": "../definitions.json#/error"
}
"expiration_date": {
"description": "Hold end date",
"type": [
"string",
"null"
],
"format": "date"
},
"404": {
"description": "Hold not found",
"schema": {
"$ref": "../definitions.json#/error"
}
"notes": {
"description": "Notes related to this hold",
"type": [
"string",
"null"
]
},
"409": {
"description": "Hold not allowed",
"schema": {
"$ref": "../definitions.json#/error"
}
"item_type": {
"description": "Limit hold on one itemtype (ignored for item-level holds)",
"type": [
"string",
"null"
]
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"503": {
"description": "Under maintenance",
"schema": {
"$ref": "../definitions.json#/error"
}
"default_patron_home": {
"description": "For each patron, set pickup location to patron's home library if possible",
"type": "integer"
}
},
"x-koha-authorization": {
"permissions": {
"reserveforothers": "1"
}
}
"required": [
"pickup_library_id"
],
"additionalProperties": false
}
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created club hold",
"schema": {
"$ref": "../definitions/club_hold.json"
}
},
"400": {
"description": "Missing or wrong parameters",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"401": {
"description": "Authentication required",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"403": {
"description": "Hold not allowed",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"404": {
"description": "Club not found",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"409": {
"description": "Hold not allowed",
"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": {
"reserveforothers": "1"
}
}
}
}
}

+ 5
- 0
api/v1/swagger/paths/config_smtp_servers.json View File

@@ -6,6 +6,7 @@
"tags": [
"smtp_servers"
],
"summary": "List SMTP servers",
"produces": [
"application/json"
],
@@ -73,6 +74,7 @@
"tags": [
"smtp_servers"
],
"summary": "Add SMTP server",
"parameters": [
{
"name": "body",
@@ -139,6 +141,7 @@
"tags": [
"smtp_servers"
],
"summary": "Get SMTP server",
"parameters": [
{
"$ref": "../parameters.json#/smtp_server_id_pp"
@@ -191,6 +194,7 @@
"tags": [
"smtp_servers"
],
"summary": "Update SMTP server",
"parameters": [
{
"$ref": "../parameters.json#/smtp_server_id_pp"
@@ -258,6 +262,7 @@
"tags": [
"smtp_servers"
],
"summary": "Delete SMTP server",
"parameters": [
{
"$ref": "../parameters.json#/smtp_server_id_pp"


+ 11
- 0
api/v1/swagger/paths/holds.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Holds#list",
"operationId": "listHolds",
"tags": ["holds"],
"summary": "List holds",
"parameters": [
{
"name": "hold_id",
@@ -180,6 +181,7 @@
"x-mojo-to": "Holds#add",
"operationId": "addHold",
"tags": ["holds"],
"summary": "Place hold",
"parameters": [
{
"name": "body",
@@ -298,6 +300,7 @@
"x-mojo-to": "Holds#edit",
"operationId": "editHold",
"tags": ["holds"],
"summary": "Update hold",
"parameters": [{
"$ref": "../parameters.json#/hold_id_pp"
}, {
@@ -383,6 +386,7 @@
"x-mojo-to": "Holds#edit",
"operationId": "overwriteHold",
"tags": ["holds"],
"summary": "Update hold",
"description": "This route is being deprecated and will be removed in future releases. Please migrate your project to use PATCH /holds/{hold_id} instead.",
"parameters": [{
"$ref": "../parameters.json#/hold_id_pp"
@@ -469,6 +473,7 @@
"x-mojo-to": "Holds#delete",
"operationId": "deleteHold",
"tags": ["holds"],
"summary": "Cancel hold",
"parameters": [{
"$ref": "../parameters.json#/hold_id_pp"
}
@@ -523,6 +528,7 @@
"tags": [
"holds"
],
"summary": "Update priority for the hold",
"parameters": [
{
"$ref": "../parameters.json#/hold_id_pp"
@@ -596,6 +602,7 @@
"x-mojo-to": "Holds#suspend",
"operationId": "suspendHold",
"tags": ["holds"],
"summary": "Suspend the hold",
"parameters": [{
"$ref": "../parameters.json#/hold_id_pp"
}, {
@@ -669,6 +676,7 @@
"x-mojo-to": "Holds#resume",
"operationId": "resumeHold",
"tags": ["holds"],
"summary": "Resume hold",
"parameters": [
{
"$ref": "../parameters.json#/hold_id_pp"
@@ -729,6 +737,7 @@
"x-mojo-to": "Holds#pickup_locations",
"operationId": "getHoldPickupLocations",
"tags": ["holds"],
"summary": "Get valid pickup locations for hold",
"parameters": [
{
"name": "x-koha-override",
@@ -822,6 +831,8 @@
"x-mojo-to": "Holds#update_pickup_location",
"operationId": "updateHoldPickupLocation",
"tags": ["holds"],
"summary": "Update pickup location for the hold",
"description": "Set a new pickup location for the hold",
"parameters": [
{
"$ref": "../parameters.json#/hold_id_pp"


+ 2
- 0
api/v1/swagger/paths/ill_backends.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Illbackends#list",
"operationId": "listIllbackends",
"tags": ["illbackends"],
"summary": "List ILL backends",
"parameters": [],
"produces": [
"application/json"
@@ -58,6 +59,7 @@
"x-mojo-to": "Illbackends#get",
"operationId": "getIllbackends",
"tags": ["illbackends"],
"summary": "Get ILL backend",
"parameters": [
{
"name": "ill_backend_id",


+ 1
- 0
api/v1/swagger/paths/illrequests.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Illrequests#list",
"operationId": "listIllrequests",
"tags": ["illrequests"],
"summary": "List ILL requests",
"parameters": [{
"name": "embed",
"in": "query",


+ 4
- 0
api/v1/swagger/paths/import_batch_profiles.json View File

@@ -6,6 +6,7 @@
"tags": [
"batch_import_profiles"
],
"summary": "List batch import profiles",
"parameters": [
{
"name": "name",
@@ -77,6 +78,7 @@
"tags": [
"batch_import_profiles"
],
"summary": "Add batch import profile",
"parameters": [
{
"name": "body",
@@ -195,6 +197,7 @@
"tags": [
"batch_import_profiles"
],
"summary": "Update batch import profile",
"parameters": [
{
"$ref": "../parameters.json#/import_batch_profile_id_pp"
@@ -312,6 +315,7 @@
"x-mojo-to": "ImportBatchProfiles#delete",
"operationId": "deleteImportBatchProfiles",
"tags": ["batch_import_profiles"],
"summary": "Delete batch import profile",
"parameters": [{
"$ref": "../parameters.json#/import_batch_profile_id_pp"
}


+ 2
- 0
api/v1/swagger/paths/items.json View File

@@ -6,6 +6,7 @@
"tags": [
"items"
],
"summary": "List items",
"parameters": [
{
"name": "external_id",
@@ -80,6 +81,7 @@
"x-mojo-to": "Items#get",
"operationId": "getItem",
"tags": ["items"],
"summary": "Get item",
"parameters": [{
"$ref": "../parameters.json#/item_id_pp"
}


+ 5
- 0
api/v1/swagger/paths/libraries.json View File

@@ -6,6 +6,7 @@
"tags": [
"library"
],
"summary": "List libraries",
"parameters": [
{
"name": "name",
@@ -189,6 +190,7 @@
"tags": [
"library"
],
"summary": "Add library",
"parameters": [
{
"name": "body",
@@ -261,6 +263,7 @@
"tags": [
"library"
],
"summary": "Get library",
"parameters": [
{
"$ref": "../parameters.json#/library_id_pp"
@@ -298,6 +301,7 @@
"tags": [
"library"
],
"summary": "Update library",
"parameters": [
{
"$ref": "../parameters.json#/library_id_pp"
@@ -374,6 +378,7 @@
"tags": [
"library"
],
"summary": "Delete library",
"parameters": [
{
"$ref": "../parameters.json#/library_id_pp"


+ 1
- 0
api/v1/swagger/paths/oauth.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "OAuth#token",
"operationId": "tokenOAuth",
"tags": ["oauth"],
"summary": "Get access token",
"produces": [
"application/json"
],


+ 5
- 0
api/v1/swagger/paths/patrons.json View File

@@ -4,6 +4,7 @@
"x-mojo-to": "Patrons#list",
"operationId": "listPatrons",
"tags": ["patrons"],
"summary": "List patrons",
"produces": [
"application/json"
],
@@ -460,6 +461,7 @@
"x-mojo-to": "Patrons#add",
"operationId": "addPatron",
"tags": ["patrons"],
"summary": "Add patron",
"parameters": [{
"name": "body",
"in": "body",
@@ -535,6 +537,7 @@
"x-mojo-to": "Patrons#get",
"operationId": "getPatron",
"tags": ["patrons"],
"summary": "Get patron",
"parameters": [{
"$ref": "../parameters.json#/patron_id_pp"
}],
@@ -592,6 +595,7 @@
"x-mojo-to": "Patrons#update",
"operationId": "updatePatron",
"tags": ["patrons"],
"summary": "Update patron",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -658,6 +662,7 @@
"x-mojo-to": "Patrons#delete",
"operationId": "deletePatron",
"tags": ["patrons"],
"summary": "Delete patron",
"parameters": [{
"$ref": "../parameters.json#/patron_id_pp"
}],


+ 2
- 0
api/v1/swagger/paths/patrons_account.json View File

@@ -6,6 +6,7 @@
"tags": [
"patrons"
],
"summary": "Get account information for a patron",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -67,6 +68,7 @@
"tags": [
"patrons"
],
"summary": "Add credit to a patron's account",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"


+ 5
- 0
api/v1/swagger/paths/patrons_extended_attributes.json View File

@@ -6,6 +6,7 @@
"tags": [
"patrons"
],
"summary": "List extended attributes for a patron",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -88,6 +89,7 @@
"tags": [
"patrons"
],
"summary": "Add extended attribute for a patron",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -167,6 +169,7 @@
"tags": [
"patrons"
],
"summary": "Overwrite extended attributes for a patron",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -254,6 +257,7 @@
"tags": [
"patrons"
],
"summary": "Update extended attribute",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -347,6 +351,7 @@
"tags": [
"patrons"
],
"summary": "Delete extended attribute",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"


+ 1
- 0
api/v1/swagger/paths/patrons_holds.json View File

@@ -6,6 +6,7 @@
"tags": [
"holds"
],
"summary": "List holds for a patron",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"


+ 1
- 0
api/v1/swagger/paths/patrons_password.json View File

@@ -6,6 +6,7 @@
"tags": [
"patrons"
],
"summary": "Set password for a patron",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"


+ 3
- 0
api/v1/swagger/paths/public_patrons.json View File

@@ -6,6 +6,7 @@
"tags": [
"patrons"
],
"summary": "Set password for a patron (public)",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -95,6 +96,7 @@
"tags": [
"patrons"
],
"summary": "Set if guarantors can see charges (public)",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"
@@ -171,6 +173,7 @@
"tags": [
"patrons"
],
"summary": "Set if guarantors can see checkouts",
"parameters": [
{
"$ref": "../parameters.json#/patron_id_pp"


+ 5
- 0
api/v1/swagger/paths/quotes.json View File

@@ -6,6 +6,7 @@
"tags": [
"quotes"
],
"summary": "List quotes",
"produces": [
"application/json"
],
@@ -101,6 +102,7 @@
"tags": [
"quotes"
],
"summary": "Add quote",
"parameters": [
{
"name": "body",
@@ -161,6 +163,7 @@
"tags": [
"quotes"
],
"summary": "Get quote",
"parameters": [
{
"$ref": "../parameters.json#/quote_id_pp"
@@ -207,6 +210,7 @@
"tags": [
"quotes"
],
"summary": "Update quote",
"parameters": [
{
"$ref": "../parameters.json#/quote_id_pp"
@@ -274,6 +278,7 @@
"tags": [
"quotes"
],
"summary": "Delete quote",
"parameters": [
{
"$ref": "../parameters.json#/quote_id_pp"


+ 5
- 0
api/v1/swagger/paths/transfer_limits.yaml View File

@@ -4,6 +4,7 @@
x-mojo-to: TransferLimits#list
operationId: listTransferLimits
description: "This resource returns a list of existing transfer limits."
summary: List transfer limits
tags:
- transfer
parameters:
@@ -60,6 +61,7 @@
description: "This resource accepts a new transfer limit and creates it if it does not already exist."
tags:
- transfer
summary: Add a transfer limit
parameters:
- name: body
in: body
@@ -108,6 +110,7 @@
description: "This resource deletes a transfer limit for the given limit id"
tags:
- transfer
summary: Delete transfer limit
parameters:
- "$ref": "../parameters.json#/transfer_limit_id_pp"
produces:
@@ -179,6 +182,7 @@
```"
tags:
- transfer
summary: Batch add transfer limits
parameters:
- name: body
in: body
@@ -233,6 +237,7 @@
rather than creating them.'
tags:
- transfer
summary: Batch delete transfer limits
parameters:
- name: body
in: body


Loading…
Cancel
Save