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