Bug 22615: Add endpoint for getting one ill backend
[koha.git] / api / v1 / swagger / paths / ill_backends.json
1 {
2     "/ill_backends": {
3         "get": {
4             "x-mojo-to": "Illbackends#list",
5             "operationId": "listIllbackends",
6             "tags": ["illbackends"],
7             "parameters": [],
8             "produces": [
9                 "application/json"
10             ],
11             "responses": {
12                 "200": {
13                     "description": "A list of ILL backends",
14                     "schema": {
15                         "$ref": "../definitions.json#/ill_backends"
16                     }
17                 },
18                 "401": {
19                   "description": "Authentication required",
20                   "schema": {
21                     "$ref": "../definitions.json#/error"
22                   }
23                 },
24                 "403": {
25                   "description": "Access forbidden",
26                   "schema": {
27                     "$ref": "../definitions.json#/error"
28                   }
29                 },
30                 "404": {
31                   "description": "ILL backends not found",
32                   "schema": {
33                     "$ref": "../definitions.json#/error"
34                   }
35                 },
36                 "500": {
37                   "description": "Internal server error",
38                   "schema": {
39                     "$ref": "../definitions.json#/error"
40                   }
41                 },
42                 "503": {
43                   "description": "Under maintenance",
44                   "schema": {
45                     "$ref": "../definitions.json#/error"
46                   }
47                 }
48             },
49             "x-koha-authorization": {
50                 "permissions": {
51                     "ill": "1"
52                 }
53             }
54         }
55     },
56     "/ill_backends/{ill_backend_id}": {
57         "get": {
58             "x-mojo-to": "Illbackends#get",
59             "operationId": "getIllbackends",
60             "tags": ["illbackends"],
61             "parameters": [
62                 {
63                     "name": "ill_backend_id",
64                     "in": "path",
65                     "description": "ILL backend id/name",
66                     "required": true,
67                     "type": "string"
68                 }
69             ],
70             "produces": [
71                 "application/json"
72             ],
73             "responses": {
74                 "200": {
75                     "description": "An ILL backends",
76                     "schema": {
77                         "$ref": "../definitions.json#/ill_backend"
78                     }
79                 },
80                 "401": {
81                   "description": "Authentication required",
82                   "schema": {
83                     "$ref": "../definitions.json#/error"
84                   }
85                 },
86                 "403": {
87                   "description": "Access forbidden",
88                   "schema": {
89                     "$ref": "../definitions.json#/error"
90                   }
91                 },
92                 "404": {
93                   "description": "ILL backends not found",
94                   "schema": {
95                     "$ref": "../definitions.json#/error"
96                   }
97                 },
98                 "500": {
99                   "description": "Internal server error",
100                   "schema": {
101                     "$ref": "../definitions.json#/error"
102                   }
103                 },
104                 "503": {
105                   "description": "Under maintenance",
106                   "schema": {
107                     "$ref": "../definitions.json#/error"
108                   }
109                 }
110             },
111             "x-koha-authorization": {
112                 "permissions": {
113                     "ill": "1"
114                 }
115             }
116         }
117     }
118 }