-
Notifications
You must be signed in to change notification settings - Fork 0
/
knowgo-adaptation-api.yaml
512 lines (509 loc) · 15.1 KB
/
knowgo-adaptation-api.yaml
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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
---
openapi: 3.0.1
info:
title: KnowGo Adaptation API
description: |
The KnowGo Adaptation API defines the endpoints used by the KnowGo backend
to support run-time reconfiguration, monitoring, and notification of
adaptation events, both on the backend as a whole, as well as on individual
users.
A pub/sub interface for notifications is further provided, providing
adaptation notifications via registered REST API callbacks.
This work has received funding from the European Union’s Horizon 2020
research and innovation programme under grant agreements No. 731678 and
No. 825480.
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 0.0.2
servers:
- url: https://api.knowgo.io/v1
- url: http://api.knowgo.io/v1
security:
- api_key: []
tags:
- name: notifications
description: Subscribe/Unsubscribe to platform event notifications
- name: adaptation
description: Trigger/Monitor adaptation of the platform backend
paths:
/notifications/subscribe:
post:
tags:
- notifications
summary: Subscribe to event notifications
operationId: notificationsSubscribe
parameters:
- name: event
in: query
description: the event type to subscribe to
required: false
style: form
explode: true
schema:
type: string
example: country-change
enum:
- country-change
- name: callbackUrl
in: query
description: the location where notifications will be sent
required: false
style: form
explode: true
schema:
type: string
format: uri
example: https://server.ip/callback
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/body'
responses:
"201":
description: subscription successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_201'
links:
unsubscribeOperation:
operationId: notificationsUnsubscribe
parameters:
subscriptionId: $response.body/#subscriptionId
description: Unsubscribe from event notifications
"401":
description: Unauthorized
"422":
description: Callback already registered
callbacks:
countryChangeNotification:
'{$request.body.callbackUrl}':
post:
operationId: countryChangeNotification
requestBody:
content:
application/json:
schema:
required:
- entering
- leaving
type: object
properties:
entering:
type: string
example: de
leaving:
type: string
example: at
timestamp:
type: string
format: date-time
responses:
"202":
description: |
Your server implementation should return this HTTP status
code if the data was received successfully
"204":
description: |
Your server should return this HTTP status code if no
longer interested in further updates
/notifications/publish:
post:
tags:
- notifications
summary: Publish an event notification
description: Publishes a dynamic JSON message to a named topic.
operationId: publishEventNotification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/body_1'
responses:
"200":
description: Message published
"400":
description: Message invalid
"401":
description: Unauthorized
/notifications/refresh:
post:
tags:
- notifications
summary: Refresh an event notification subscription
operationId: refreshSubscription
parameters:
- name: subscriptionId
in: query
description: the subscriber ID to refresh
required: false
style: form
explode: true
schema:
type: string
format: uuid
example: 3231b2ab-1520-473f-b46a-b465c66de9a9
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/body_2'
responses:
"200":
description: Successfully refreshed subscription expiry
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200'
"401":
description: Unauthorized
"404":
description: Subscription not found
"500":
description: Internal server error
/notifications/unsubscribe:
post:
tags:
- notifications
summary: Unsubscribe from event notifications
operationId: notificationsUnsubscribe
parameters:
- name: subscriptionId
in: query
description: the subscriber ID to unsubscribe
required: false
style: form
explode: true
schema:
type: string
format: uuid
example: 3231b2ab-1520-473f-b46a-b465c66de9a9
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/body_3'
responses:
"200":
description: Unsubscribed
/adaptation:
get:
tags:
- adaptation
summary: See the current adaptation scheme in use by the backend
operationId: getAdaptationScheme
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_1'
"401":
description: Unauthorized
post:
tags:
- adaptation
summary: Update the current adaptation scheme in use by the backend
description: |
Sets the adaptation scheme used by the backend. New users of the
system will automatically inherit this adaptation scheme, while users
with a pre-existing adaptation scheme that is weaker than the proposed
server adaptation will be automatically migrated during the course of
carrying out the server adaptation. Users that have a more restrictive
adaptation scheme in place will be unaffected by changes to the server
adaptation.
Server adaptation (and any adaptation of affected users) is carried
out asynchronously, with each user adaptation and the final server
adaptation status being reported to the completion callback, if
provided.
operationId: updateAdaptationScheme
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/body_4'
required: true
responses:
"201":
description: Adaptation request registered
"401":
description: Unauthorized
callbacks:
adaptationCompletion:
'{$request.body.completionUrl}':
post:
operationId: adaptationCompletion
requestBody:
content:
application/json:
schema:
required:
- status
type: object
properties:
status:
type: string
example: OK
enum:
- OK
- failed
responses:
"202":
description: |
Your server implementation should return this HTTP status
code if the data was received successfully
"204":
description: |
Your server should return this HTTP status code if no
longer interested in further updates
/users/{userId}/adaptation:
get:
tags:
- adaptation
summary: See the current adaptation scheme in use by the specified user
operationId: getUserAdaptationScheme
parameters:
- name: userId
in: path
description: ID of Driver
required: true
style: simple
explode: false
schema:
type: integer
format: int64
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_2'
"401":
description: Unauthorized
post:
tags:
- adaptation
summary: Update the current adaptation scheme in use by the specified user
description: |
Sets an adaptation scheme for a specific user. The user adaptation
scheme must be equal or more restrictive than the minimum set by the
server. Note that the server may further constrain the user-specific
adaptation scheme in the case where the user scheme is of a weaker type
than that required by the server.
operationId: updateUserAdaptationScheme
parameters:
- name: userId
in: path
description: ID of Driver
required: true
style: simple
explode: false
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/body_5'
required: true
responses:
"201":
description: Adaptation request registered
"401":
description: Unauthorized
"403":
description: Adaptation request refused - proposed scheme is weaker than server minimum
callbacks:
userAdaptationCompletion:
'{$request.body.completionUrl}':
post:
operationId: userAdaptationCompletion
requestBody:
content:
application/json:
schema:
required:
- driverId
- status
type: object
properties:
driverId:
type: integer
format: int64
example: 1
status:
type: string
example: OK
enum:
- OK
- failed
responses:
"202":
description: |
Your server implementation should return this HTTP status
code if the data was received successfully
"204":
description: |
Your server should return this HTTP status code if no
longer interested in further updates
components:
schemas:
body_3:
type: object
properties:
subscriptionId:
type: string
format: uuid
example: 3231b2ab-1520-473f-b46a-b465c66de9a9
body_4:
required:
- scheme
type: object
properties:
scheme:
type: string
example: EdgePushDown
enum:
- None
- BlockSensitiveStoring
- CountryRedirection
- EdgePushDown
completionUrl:
type: string
format: uri
example: https://server.ip/callback
body_1:
required:
- id
- message
type: object
properties:
id:
type: string
description: Event type
example: country-change
message:
type: object
description: A dynamic JSON object to publish
format: json
example:
driverId: 1
entering: de
leaving: at
timestamp: 2019-12-12T21:23:26+01:00
body_2:
type: object
properties:
subscriptionId:
type: string
format: uuid
example: 3231b2ab-1520-473f-b46a-b465c66de9a9
inline_response_201:
required:
- subscriptionId
properties:
subscriptionId:
type: string
description: this unique identifier allows management of the subscription
format: uuid
example: 3231b2ab-1520-473f-b46a-b465c66de9a9
expiresAt:
type: string
description: time that the subscription will expire, unless refreshed
format: date-time
example: 2019-12-12T17:20:11+01:00
description: subscription information
inline_response_200_1:
required:
- scheme
type: object
properties:
scheme:
type: string
example: EdgePushDown
enum:
- None
- BlockSensitiveStoring
- CountryRedirection
- EdgePushDown
since:
type: string
format: date-time
inline_response_200:
required:
- expiresAt
- subscriptionId
properties:
subscriptionId:
type: string
description: this unique identifier allows management of the subscription
format: uuid
example: 3231b2ab-1520-473f-b46a-b465c66de9a9
expiresAt:
type: string
description: time that the subscription will expire, unless refreshed
format: date-time
example: 2019-12-12T17:20:11+01:00
description: subscription information
inline_response_200_2:
required:
- driverId
- scheme
type: object
properties:
driverId:
type: integer
format: int64
example: 1
scheme:
type: string
example: EdgePushDown
enum:
- None
- BlockSensitiveStoring
- CountryRedirection
- EdgePushDown
since:
type: string
format: date-time
body:
type: object
properties:
event:
type: string
example: country-change
enum:
- country-change
callbackUrl:
type: string
format: uri
example: https://server.ip/callback
body_5:
required:
- scheme
type: object
properties:
scheme:
type: string
example: EdgePushDown
enum:
- None
- BlockSensitiveStoring
- CountryRedirection
- EdgePushDown
completionUrl:
type: string
format: uri
example: https://server.ip/callback
securitySchemes:
api_key:
type: apiKey
name: X-API-Key
in: header