-
Notifications
You must be signed in to change notification settings - Fork 7
/
openapi.yml
462 lines (461 loc) · 19 KB
/
openapi.yml
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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
openapi: 3.0.0
info:
title: IUDX Adaptors APIs
version: '1.0'
servers:
-
url: 'http://localhost:8081'
description: localhost
-
url: 'https://adaptor.iudx.io'
description: Dev Instance
paths:
/adaptor:
description: Submit a new Adaptor spec json
get:
responses:
'200':
$ref: '#/components/responses/AdaptorListResponse'
'401':
description: An unauthorized operation
operationId: getAdaptors
description: Get all adaptors registered for the user whose credentials are provided
post:
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SpecObject'
description: ''
required:
- name
- inputSpec
- parseSpec
- deduplicationSpec
- transformSpec
- publishSpec
properties:
name:
minLength: 1
type: string
inputSpec:
required:
- type
- url
- requestType
- pollingInterval
type: object
properties:
type:
minLength: 1
type: string
url:
minLength: 1
type: string
requestType:
minLength: 1
type: string
pollingInterval:
type: number
parseSpec:
required:
- type
- messageContainer
- containerPath
- keyPath
- timestampPath
type: object
properties:
type:
minLength: 1
type: string
messageContainer:
minLength: 1
type: string
containerPath:
minLength: 1
type: string
keyPath:
minLength: 1
type: string
timestampPath:
minLength: 1
type: string
deduplicationSpec:
required:
- type
type: object
properties:
type:
minLength: 1
type: string
transformSpec:
required:
- type
- joltSpec
type: object
properties:
type:
minLength: 1
type: string
joltSpec:
minItems: 1
uniqueItems: true
type: array
items:
required:
- operation
properties:
operation:
minLength: 1
type: string
spec:
required:
- time
- deviceId
- k1
type: object
properties:
time:
minLength: 1
type: string
deviceId:
minLength: 1
type: string
k1:
minLength: 1
type: string
publishSpec:
required:
- type
- url
- port
- uname
- password
- sinkName
- tagName
type: object
properties:
type:
minLength: 1
type: string
url:
minLength: 1
type: string
port:
type: number
uname:
minLength: 1
type: string
password:
minLength: 1
type: string
sinkName:
minLength: 1
type: string
tagName:
minLength: 1
type: string
examples:
example-1:
value:
name: FlinkTestApp
inputSpec:
type: http
url: 'http://mockserver:8080/simpleB'
requestType: GET
pollingInterval: -1
parseSpec:
type: json
messageContainer: array
containerPath: $.data
keyPath: $.deviceId
timestampPath: $.time
deduplicationSpec:
type: timeBased
transformSpec:
type: jolt
joltSpec:
-
operation: shift
spec:
time: observationDateTime
deviceId: id
k1: k1
-
operation: modify-overwrite-beta
spec:
id: '=concat(''datakaveri.org/123/'', id)'
publishSpec:
type: rmq
url: 'amqp://mockrmq'
port: 5672
uname: guest
password: guest
sinkName: adaptor-test
tagName: test
required: true
parameters:
-
name: username
schema:
type: string
in: header
required: true
-
name: password
schema:
type: string
in: header
required: true
responses:
'202':
description: The spec is valid and is being processed.
'400':
description: The spec is invalid
'401':
description: An unauthorized operation
operationId: newAdaptor
summary: ''
description: Submit the Adaptor spec pipeline file from which a JAR of the pipeline will be generated.
parameters:
-
name: username
description: 'Username '
schema:
type: string
in: header
required: true
-
name: password
description: |
Password
schema:
type: string
in: header
required: true
'/adaptor/{id}':
description: Operations on a specific adaptor given its id
get:
tags: []
parameters:
-
name: username
schema:
type: string
in: header
required: true
-
name: password
schema:
type: string
in: header
required: true
responses:
'200':
$ref: '#/components/responses/AdaptorResponse'
operationId: getAdaptor
description: Get all the config(s)
delete:
parameters:
-
name: username
schema:
type: string
in: header
required: true
-
name: password
schema:
type: string
in: header
required: true
responses:
'200':
description: Adaptor deleted
'401':
description: Unauthorized to delete the Adaptor
'404':
description: No such adaptor exists
operationId: deleteAdaptor
description: Deletes the Adaptor given its id
parameters:
-
name: username
description: Username
schema:
type: string
in: header
required: true
-
name: password
description: Password
schema:
type: string
in: header
required: true
components:
schemas:
SpecObject:
title: Root Type for SpecObject
description: The adaptor specification object
type: object
properties:
name:
type: string
inputSpec:
type: object
properties:
type:
type: string
url:
type: string
requestType:
type: string
pollingInterval:
format: int32
type: integer
parseSpec:
type: object
properties:
type:
type: string
messageContainer:
type: string
containerPath:
type: string
keyPath:
type: string
timestampPath:
type: string
inputTimeFormat:
type: string
outputTimeFormat:
type: string
deduplicationSpec:
type: object
properties:
type:
type: string
transformSpec:
type: object
properties:
type:
type: string
template:
type: string
jsonPathSpec:
type: array
items:
type: object
properties:
outputKeyPath:
type: string
inputValuePath:
type: string
publishSpec:
type: object
properties:
type:
type: string
url:
type: string
port:
format: int32
type: integer
uname:
type: string
password:
type: string
sinkName:
type: string
tagName:
type: string
example:
name: test
inputSpec:
type: http
url: 'http://mockserver:8080/simpleB'
requestType: GET
pollingInterval: 1000
parseSpec:
type: json
messageContainer: array
containerPath: $.data
keyPath: $.deviceId
timestampPath: $.time
inputTimeFormat: 'yyyy-MM-dd''T''HH:mm:ssXXX'
outputTimeFormat: 'yyyy-MM-dd''T''HH:mm:ssXXX'
deduplicationSpec:
type: timeBased
transformSpec:
type: jsPath
template: '{ ''observationDateTime'': ''2021'', ''co2'': { ''avgOverTime'': 100}, ''id'': ''abc''}'
jsonPathSpec:
-
outputKeyPath: $.observationDateTime
inputValuePath: $.time
-
outputKeyPath: $.co2.avgOverTime
inputValuePath: $.k1
-
outputKeyPath: $.id
inputValuePath: $.deviceId
valueModifierScript: 'value.split(''-'')[0]'
publishSpec:
type: rmq
url: 'amqp://mockrmq'
port: 5672
uname: guest
password: guest
sinkName: adaptor-test
tagName: test
AdaptorListObject:
title: Root Type for AdaptorListObject
description: 'List of adaptors '
type: object
properties:
adaptors:
type: array
items:
$ref: '#/components/schemas/AdaptorObject'
example:
adaptors:
-
id: <adaptor-uuid>
name: <name of adaptor>
status: <running|stopped|paused|error>
lastSeen: '2021-05-10T07:35:34Z'
AdaptorObject:
title: Root Type for AdaptorObject
description: Information about a particular adaptor
type: object
properties:
id:
type: string
name:
type: string
status:
type: string
lastSeen:
format: date-time
type: string
example:
id: <adaptor-uuid>
name: <name of adaptor>
status: <running|stopped|paused|error>
lastSeen: '2021-05-10T07:35:34Z'
responses:
AdaptorListResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/AdaptorListObject'
description: List of adaptors
AdaptorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/AdaptorObject'
description: Detail of a single Adaptor