From 1c07f93e2b1cf5c1978b80d2dd8ca5622b2062b4 Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Mon, 23 Sep 2019 12:48:02 -0300 Subject: [PATCH] Bug 23667: Add spec --- api/v1/swagger/paths.json | 9 ++-- api/v1/swagger/paths/items.json | 76 +++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 3 deletions(-) diff --git a/api/v1/swagger/paths.json b/api/v1/swagger/paths.json index 0264c0f0c1..613827178b 100644 --- a/api/v1/swagger/paths.json +++ b/api/v1/swagger/paths.json @@ -41,6 +41,12 @@ "/holds/{hold_id}/suspension": { "$ref": "paths/holds.json#/~1holds~1{hold_id}~1suspension" }, + "/items": { + "$ref": "paths/items.json#/~1items" + }, + "/items/{item_id}": { + "$ref": "paths/items.json#/~1items~1{item_id}" + }, "/libraries": { "$ref": "paths/libraries.json#/~1libraries" }, @@ -50,9 +56,6 @@ "/checkouts/{checkout_id}/allows_renewal": { "$ref": "paths/checkouts.json#/~1checkouts~1{checkout_id}~1allows_renewal" }, - "/items/{item_id}": { - "$ref": "paths/items.json#/~1items~1{item_id}" - }, "/patrons": { "$ref": "paths/patrons.json#/~1patrons" }, diff --git a/api/v1/swagger/paths/items.json b/api/v1/swagger/paths/items.json index 28e136d7a9..86197eadf1 100644 --- a/api/v1/swagger/paths/items.json +++ b/api/v1/swagger/paths/items.json @@ -1,4 +1,80 @@ { + "/items": { + "get": { + "x-mojo-to": "Items#list", + "operationId": "listItems", + "tags": [ + "items" + ], + "parameters": [ + { + "name": "external_id", + "in": "query", + "description": "Search on the item's barcode", + "required": false, + "type": "string" + }, + { + "$ref": "../parameters.json#/match" + }, + { + "$ref": "../parameters.json#/order_by" + }, + { + "$ref": "../parameters.json#/page" + }, + { + "$ref": "../parameters.json#/per_page" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A list of item", + "schema": { + "type": "array", + "items": { + "$ref": "../definitions.json#/item" + } + } + }, + "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" + } + }, + "503": { + "description": "Under maintenance", + "schema": { + "$ref": "../definitions.json#/error" + } + } + }, + "x-koha-authorization": { + "permissions": { + "catalogue": "1" + } + } + } + }, "/items/{item_id}": { "get": { "x-mojo-to": "Items#get", -- 2.23.0