-
Notifications
You must be signed in to change notification settings - Fork 610
Expand file tree
/
Copy pathsubscriptions-openapi.yaml
More file actions
478 lines (477 loc) · 15.7 KB
/
subscriptions-openapi.yaml
File metadata and controls
478 lines (477 loc) · 15.7 KB
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
openapi: 3.0.0
info:
title: CloudEvents Subscriptions API
version: 0.2-WIP
servers:
- url: https://server.example.com/v0.1
paths:
/subscriptions:
get:
operationId: getSubscriptions
description: Retrieve multiple subscriptions
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
description: a list of subscriptions
items:
$ref: "#/components/schemas/Subscription"
post:
operationId: createSubscription
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriptionRequest"
responses:
"201":
description: Created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
headers:
Location:
schema:
type: string
format: url
"400":
description: Invalid or malformed request
options:
operationId: getFeatures
description: Discover supported features and methods for this endpoint
responses:
"200":
description: OK
headers:
Allow:
schema:
type: string
default: "GET,POST,OPTIONS"
/subscriptions/{id}:
get:
operationId: getSubscription
description: Retrieve a subscription
parameters:
- in: "path"
name: "id"
description: identifier of a specific subscription
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
"404":
description: Subscription not found
put:
operationId: updateSubscription
description: Update a subscription
parameters:
- in: "path"
name: "id"
required: true
schema:
type: string
description: The id of an existing subscription
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
"400":
description: Invalid or malformed request
"404":
description: Subscription not found
delete:
operationId: deleteSubscription
description: Delete a subscription
parameters:
- in: "path"
name: "id"
required: true
schema:
type: string
description: The id of an existing subscription
responses:
"200":
description: Successfully deleted
"404":
description: Subscription not found
options:
operationId: getSubscriptionFeatures
description: Discover supported features and methods for this endpoint
parameters:
- in: "path"
name: "id"
description: identifier of a specific subscription
required: true
schema:
type: string
responses:
"200":
description: OK
headers:
Allow:
schema:
type: string
default: "GET,PUT,DELETE,OPTIONS"
components:
schemas:
SubscriptionRequest:
properties:
protocol:
$ref: "#/components/schemas/Protocol"
protocolsettings:
oneOf:
- $ref: "#/components/schemas/ProtocolSettings"
- $ref: "#/components/schemas/AMQPSettings"
- $ref: "#/components/schemas/ApacheKafkaSettings"
- $ref: "#/components/schemas/HTTPSettings"
- $ref: "#/components/schemas/MQTTSettings"
- $ref: "#/components/schemas/NATSSettings"
sink:
type: string
format: url
description: REQUIRED. The address to which events shall be delivered using the selected protocol.
example: "https://endpoint.example.com/webhook"
sinkcredential:
oneOf:
- $ref: "#/components/schemas/SinkCredential"
- $ref: "#/components/schemas/AccessTokenCredential"
- $ref: "#/components/schemas/PlainCredential"
- $ref: "#/components/schemas/RefreshTokenCredential"
source:
type: string
format: uri-reference
description: OPTIONAL. Source to which the subscription applies. May be implied by the request address.
types:
description: "CloudEvent types eligible to be delivered by this subscription"
type: array
items:
type: string
filters:
description: "This filter evaluates to 'true' if all contained filters are 'true'"
type: array
items:
title: "Filter entry"
oneOf:
- $ref: "#/components/schemas/Filter"
- $ref: "#/components/schemas/AllFilter"
- $ref: "#/components/schemas/AnyFilter"
- $ref: "#/components/schemas/NotFilter"
- $ref: "#/components/schemas/ExactFilter"
- $ref: "#/components/schemas/PrefixFilter"
- $ref: "#/components/schemas/SuffixFilter"
- $ref: "#/components/schemas/SqlFilter"
config:
description: OPTIONAL. Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
type: object
additionalProperties:
type: string
required:
- sink
- protocol
Subscription:
type: object
title: "Subscription"
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
id:
type: string
description: REQUIRED. The unique identifier of the subscription in the scope of the subscription manager.
example: 1119920371
required:
- id
- sink
- protocol
Protocol:
type: string
enum: ["HTTP", "MQTT3", "MQTT5", "AMQP", "NATS", "KAFKA"]
description: REQUIRED. Identifier of a delivery protocol.
example: "HTTP"
Filter:
title: "Filter"
description: "A filter from a selection of multiple filter types and dialects"
type: object
additionalProperties: true
AllFilter:
allOf:
- $ref: "#/components/schemas/Filter"
- type: object
description: "all filter"
properties:
all:
description: "This filter evaluates to 'true' if all contained filters are 'true'"
type: array
minItems: 1
items:
title: "Filter entry"
oneOf:
- $ref: "#/components/schemas/Filter"
- $ref: "#/components/schemas/AllFilter"
- $ref: "#/components/schemas/AnyFilter"
- $ref: "#/components/schemas/NotFilter"
- $ref: "#/components/schemas/ExactFilter"
- $ref: "#/components/schemas/PrefixFilter"
- $ref: "#/components/schemas/SuffixFilter"
- $ref: "#/components/schemas/SqlFilter"
additionalProperties: false
AnyFilter:
allOf:
- $ref: "#/components/schemas/Filter"
- type: object
description: "any filter"
properties:
any:
description: "This filter evaluates to 'true' if any contained filters are 'true'"
type: array
minItems: 1
items:
title: "Filter entry"
oneOf:
- $ref: "#/components/schemas/Filter"
- $ref: "#/components/schemas/AllFilter"
- $ref: "#/components/schemas/AnyFilter"
- $ref: "#/components/schemas/NotFilter"
- $ref: "#/components/schemas/ExactFilter"
- $ref: "#/components/schemas/PrefixFilter"
- $ref: "#/components/schemas/SuffixFilter"
- $ref: "#/components/schemas/SqlFilter"
additionalProperties: false
NotFilter:
allOf:
- $ref: "#/components/schemas/Filter"
- type: object
description: "not filter"
properties:
not:
type: object
oneOf:
- $ref: "#/components/schemas/Filter"
- $ref: "#/components/schemas/AllFilter"
- $ref: "#/components/schemas/AnyFilter"
- $ref: "#/components/schemas/NotFilter"
- $ref: "#/components/schemas/ExactFilter"
- $ref: "#/components/schemas/PrefixFilter"
- $ref: "#/components/schemas/SuffixFilter"
- $ref: "#/components/schemas/SqlFilter"
additionalProperties: false
ExactFilter:
allOf:
- $ref: "#/components/schemas/Filter"
- type: object
title: "exact filter"
description: "This filter evaluates to 'true' if the 'value' exactly matches the value of the indicated CloudEvents context attribute"
properties:
exact:
$ref: "#/components/schemas/CloudEventsAttribute"
additionalProperties: false
PrefixFilter:
allOf:
- $ref: "#/components/schemas/Filter"
- type: object
title: "prefix filter"
description: "This filter evaluates to 'true' if the 'value' is a prefix of the value of the indicated CloudEvents context attribute"
properties:
prefix:
$ref: "#/components/schemas/CloudEventsAttribute"
additionalProperties: false
SuffixFilter:
allOf:
- $ref: "#/components/schemas/Filter"
- type: object
title: "suffix filter"
description: "This filter evaluates to 'true' if the 'value' is a suffix of the value of the indicated CloudEvents context attribute"
properties:
suffix:
$ref: "#/components/schemas/CloudEventsAttribute"
additionalProperties: false
SqlFilter:
allOf:
- $ref: "#/components/schemas/Filter"
- type: object
description: "CESQL filter"
properties:
sql:
type: string
description: "The CESQL expression"
additionalProperties: true
CloudEventsAttribute:
type: object
description: "CloudEvents defined attributes."
additionalProperties: # extension attributes
type: string
properties:
id:
type: string
description: Identifies the event.
source:
type: string
description: Identifies the context in which an event happened.
specversion:
type: string
description: The version of the CloudEvents specification which the event uses.
type:
type: string
description: Describes the type of event related to the originating occurrence.
datacontenttype:
type: string
description: Content type of the data value.
dataschema:
type: string
description: Identifies the schema that data adheres to.
subject:
type: string
description: Describes the subject of the event in the context of the event producer.
time:
type: string
description: Timestamp of when the occurrence happened.
ProtocolSettings:
type: object
additionalProperties: false
HTTPSettings:
type: object
allOf:
- $ref: "#/components/schemas/ProtocolSettings"
- properties:
headers:
type: object
additionalProperties:
type: string
method:
type: string
MQTTSettings:
type: object
allOf:
- $ref: "#/components/schemas/ProtocolSettings"
- properties:
topicname:
type: string
qos:
type: integer
format: int32
retain:
type: boolean
expiry:
type: integer
format: int32
userproperties:
type: object
required:
- topicname
AMQPSettings:
type: object
allOf:
- $ref: "#/components/schemas/ProtocolSettings"
- properties:
address:
type: string
linkName:
type: string
sendersettlementmode:
type: string
enum: ["settled", "unsettled"]
linkProperties:
type: object
additionalProperties:
type: string
ApacheKafkaSettings:
type: object
allOf:
- $ref: "#/components/schemas/ProtocolSettings"
- properties:
topicname:
type: string
partitionkeyextractor:
type: string
clientid:
type: string
ackmode:
type: integer
required:
- topicname
NATSSettings:
type: object
allOf:
- $ref: "#/components/schemas/ProtocolSettings"
- properties:
subject:
type: string
required:
- subject
SinkCredential:
type: object
properties:
credentialtype:
type: string
enum: ["PLAIN", "ACCESSTOKEN", "REFRESHTOKEN"]
description: "The type of the credential."
additionalProperties: false
PlainCredential:
type: object
description: A plain credential as a combination of an identifier and a secret.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- properties:
identifier:
description: The identifier might be an account or username.
type: string
secret:
description: The secret might be a password or passphrase.
type: string
AccessTokenCredential:
type: object
description: An access token credential.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- properties:
accesstoken:
description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
type: string
accesstokenexpiresutc:
type: string
format: date-time
description: RECOMMENDED. An absolute UTC instant at which the token shall be considered expired.
accesstokentype:
description: OPTIONAL. )Type of the access token (See https://tools.ietf.org/html/rfc6749#section-7.1).
type: string
default: bearer
required:
- accesstoken
- accesstokenexpiresutc
RefreshTokenCredential:
type: object
description: An access token credential with a refresh token.
allOf:
- $ref: "#/components/schemas/AccessTokenCredential"
- type: object
properties:
refreshtoken:
description: REQUIRED. An refresh token credential used to acquire access tokens.
type: string
refreshtokenendpoint:
type: string
format: uri
description: REQUIRED. A URL at which the refresh token can be traded for an access token.
required:
- refreshtoken
- refreshtokenendpoint