forked from folio-org/okapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathokapi.raml
390 lines (373 loc) · 9.57 KB
/
okapi.raml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
#%RAML 0.8
title: Okapi Core API
version: 0.1
baseUri: https://okapi.cloud
## mediaType: application/json
schemas:
- DeploymentDescriptor: !include DeploymentDescriptor.json
- LaunchDescriptor: !include LaunchDescriptor.json
- DeploymentDescriptorList: !include DeploymentDescriptorList.json
- ModuleDescriptor: !include ModuleDescriptor.json
- ModuleList: !include ModuleList.json
- TenantDescriptor: !include TenantDescriptor.json
- TenantList: !include TenantList.json
- TenantModuleDescriptor: !include TenantModuleDescriptor.json
- TenantModuleDescriptorList: !include TenantModuleDescriptorList.json
- HealthStatus: !include HealthStatus.json
- HealthStatusList: !include HealthStatusList.json
- HealthDescriptor: !include HealthDescriptor.json
- HealthDescriptorList: !include HealthDescriptorList.json
- NodeDescriptor: !include NodeDescriptor.json
- NodeDescriptorList: !include NodeDescriptorList.json
#traits:
# The following are a set of APIs that module web service must accept/consume
# to allow okapi environment to orchestrate it
#
# This version assumes that a module instance may be shared by multiple
# tenants, e.g. we have a global set of module instances
# TODO we will most likely need a web service to list and browse module types
# DEPLOYMENT SERVICE
/_/deployment/modules:
post:
description: deploy (launch process, start a container, etc) instance of a
particular service, according to the deployment descriptor
body:
application/json:
schema: DeploymentDescriptor
responses:
201:
description: Created
headers:
Location:
description: URI to the descriptor of the deployed instance
body:
application/json:
schema: DeploymentDescriptor
400:
description: Bad Request
body:
text/plain:
500:
description: Server Error
body:
text/plain:
get:
description: list all deployed instances
responses:
200:
body:
application/json:
schema: DeploymentDescriptorList
/{instance_id}:
get:
description: retrieve deployment descriptor for a particular instance
responses:
200:
body:
application/json:
schema: DeploymentDescriptor
delete:
description: shutdown instance
responses:
204:
# DISCOVERY SERVICE
/_/discovery/modules:
post:
description: register instance under a specified service id
body:
application/json:
schema: DeploymentDescriptor
responses:
201:
description: Created
headers:
Location:
description: URI to the registered instance
body:
application/json:
schema: DeploymentDescriptor
400:
description: Bad Request
body:
text/plain:
500:
description: Server Error
body:
text/plain:
get:
description: return all instances
responses:
200:
description: Created
headers:
Location:
description: URI to the registered instance
body:
application/json:
schema: DeploymentDescriptorList
400:
description: Bad Request
body:
text/plain:
500:
description: Server Error
body:
text/plain:
/{service_id}:
get:
description: list all instances for a particular service
responses:
200:
body:
application/json:
schema: DeploymentDescriptorList
400:
description: Bad Request
body:
text/plain:
500:
description: Server Error
body:
text/plain:
/{instance_id}:
get:
description: update registration of a specified instance
responses:
200:
body:
application/json:
schema: DeploymentDescriptor
put:
description: update registration of a specified instance
responses:
200:
body:
application/json:
schema: DeploymentDescriptor
delete:
description: remove registration for a given instance
responses:
204:
/_/discovery/health:
get:
description: get health info for all services
responses:
200:
body:
application/json:
schema: HealthDescriptorList
400:
description: Bad Request
body:
text/plain:
500:
description: Server Error
body:
text/plain:
/{service_id}:
get:
description: health for all instances for a particular service
responses:
200:
body:
application/json:
schema: HealthDescriptorList
/{instance_id}:
get:
description: get health for a particular instance
responses:
200:
body:
application/json:
schema: HealthDescriptor
/_/discovery/nodes:
get:
description: get list of all nodes
responses:
200:
body:
application/json:
schema: NodeDescriptorList
400:
description: Bad Request
body:
text/plain:
500:
description: Server Error
body:
text/plain:
/{node_id}:
get:
description: get info for one node
responses:
200:
body:
application/json:
schema: NodeDescriptor
400:
description: Bad Request
body:
text/plain:
404:
description: Not Found
body:
text/plain:
500:
description: Server Error
body:
text/plain:
# PROXY SERVICE
/_/proxy/modules:
post:
description: announce new module to the proxy, once successful a module
can be selected for a specific tenant
body:
application/json:
schema: ModuleDescriptor
responses:
201:
description: Created
headers:
Location:
description: URI to the created module instance
body:
application/json:
schema: ModuleDescriptor
400:
description: Bad Request
body:
text/plain:
500:
description: Server Error
body:
text/plain:
get:
description: list all available modules
responses:
200:
body:
application/json:
schema: ModuleList
/{module_id}:
get:
description: retrieve descriptor for a particular module
responses:
200:
body:
application/json:
schema: ModuleDescriptor
put:
description: update descriptor of a particular module
responses:
200:
body:
application/json:
schema: ModuleDescriptor
delete:
description: remove module descriptor for a particular module, module
will no longer be selectable by tenants
responses:
204:
/_/proxy/tenants:
post:
description: create a new tenant
body:
application/json:
schema: TenantDescriptor
responses:
201:
description: tenant has been created
headers:
Location:
description: URI to the created tenant
body:
application/json:
schema: TenantDescriptor
400:
description: Bad Request
body:
text/plain:
get:
description: list all tenants
responses:
200:
description: list of tenants in a brief format
body:
application/json:
schema: TenantList
/{tenant_id}:
get:
description: retrieve a tenant
responses:
200:
body:
application/json:
schema: TenantDescriptor
404:
description: Not Found
body:
text/plain:
put:
description: update a tenant
body:
application/json:
schema: TenantDescriptor
responses:
200:
body:
application/json:
schema: TenantDescriptor
400:
description: Bad Request
body:
text/plain:
404:
description: Not Found
body:
text/plain:
delete:
description: remove a tenant
responses:
204:
/modules:
get:
description: selection of modules by the tenant
responses:
200:
body:
application/json:
schema: TenantModuleDescriptorList
post:
description: enable a module for a specified tenant
body:
application/json:
schema: TenantModuleDescriptor
responses:
200:
body:
application/json:
schema: TenantModuleDescriptor
/{module_tenant_id}:
get:
description: look up particular module selection
responses:
200:
body:
application/json:
schema: TenantModuleDescriptor
delete:
description: remove particular module selection
responses:
204:
/_/proxy/health:
get:
description: Check health of all modules
responses:
200:
description: OK
body:
application/json:
schema: HealthStatusList
500:
description: Server Error
#TODO implement single module health check