-
Notifications
You must be signed in to change notification settings - Fork 12
/
swagger.json
638 lines (638 loc) · 24.4 KB
/
swagger.json
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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Open API for Event Sidecar",
"description": "Open API for Event Sidecar",
"license": {
"name": "Apache 2.0"
}
},
"basePath": "/",
"schemes": [
"http"
],
"produces": [
"application/json"
],
"paths": {
"/health": {
"get": {
"description": "The HTTP request GET /health is used to return the current status of the Event Sidecar API.",
"summary": "Get Health",
"tags": [
"api"
],
"operationId": "GetHealth",
"produces": [
"application/json"
],
"responses": {
"200": {
"$ref": "#/responses/ResponseHealth200"
},
"400": {
"$ref": "#/responses/ErrorResponse400"
},
"401": {
"$ref": "#/responses/ErrorResponse401"
},
"403": {
"$ref": "#/responses/ErrorResponse403"
},
"404": {
"$ref": "#/responses/ErrorResponse404"
},
"405": {
"$ref": "#/responses/ErrorResponse405"
},
"406": {
"$ref": "#/responses/ErrorResponse406"
},
"501": {
"$ref": "#/responses/ErrorResponse501"
},
"503": {
"$ref": "#/responses/ErrorResponse503"
}
}
}
},
"/event": {
"post": {
"description": "The HTTP request POST /event is a REST endpoint to add an event to a Kafka Topic.",
"summary": "Post Event",
"tags": [
"api"
],
"operationId": "PostEvent",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EventPayload"
}
}
],
"x-examples": {
"application/json": {
"from": "noresponsepayeefsp",
"to": "payerfsp",
"id": "aa398930-f210-4dcd-8af0-7c769cea1660",
"content": {
"headers": {
"content-type": "application/vnd.interoperability.transfers+json;version=1.0",
"date": "'2019-05-28T16:34:41.000Z'",
"fspiop-source": "noresponsepayeefsp",
"fspiop-destination": "payerfsp"
},
"payload": "'data:application/vnd.interoperability.transfers+json;version=1.0;base64,ewogICJmdWxmaWxtZW50IjogIlVObEo5OGhaVFlfZHN3MGNBcXc0aV9VTjN2NHV0dDdDWkZCNHlmTGJWRkEiLAogICJjb21wbGV0ZWRUaW1lc3RhbXAiOiAiMjAxOS0wNS0yOVQyMzoxODozMi44NTZaIiwKICAidHJhbnNmZXJTdGF0ZSI6ICJDT01NSVRURUQiCn0'"
},
"type": "application/json",
"metadata": {
"event": {
"id": "3920382d-f78c-4023-adf9-0d7a4a2a3a2f",
"type": "trace",
"action": "start",
"createdAt": "'2019-05-29T23:18:32.935Z'",
"state": {
"status": "success",
"code": 0,
"description": "action successful"
},
"responseTo": "1a396c07-47ab-4d68-a7a0-7a1ea36f0012"
},
"trace": {
"service": "central-ledger-prepare-handler",
"traceId": "bbd7b2c7-3978-408e-ae2e-a13012c47739",
"parentSpanId": "4e3ce424-d611-417b-a7b3-44ba9bbc5840",
"spanId": "efeb5c22-689b-4d04-ac5a-2aa9cd0a7e87",
"timestamp": "'2015-08-29T11:22:09.815479Z'"
}
}
}
},
"responses": {
"201": {
"$ref": "#/responses/Response201"
},
"400": {
"$ref": "#/responses/ErrorResponse400"
},
"401": {
"$ref": "#/responses/ErrorResponse401"
},
"403": {
"$ref": "#/responses/ErrorResponse403"
},
"404": {
"$ref": "#/responses/ErrorResponse404"
},
"405": {
"$ref": "#/responses/ErrorResponse405"
},
"406": {
"$ref": "#/responses/ErrorResponse406"
},
"501": {
"$ref": "#/responses/ErrorResponse501"
},
"503": {
"$ref": "#/responses/ErrorResponse503"
}
}
}
}
},
"definitions": {
"ErrorCode": {
"title": "ErrorCode",
"type": "string",
"pattern": "^[1-9]\\d{3}$",
"description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represents the specific error."
},
"ErrorDescription": {
"title": "ErrorDescription",
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Error description string."
},
"ExtensionKey": {
"title": "ExtensionKey",
"type": "string",
"minLength": 1,
"maxLength": 32,
"description": "Extension key."
},
"ExtensionValue": {
"title": "ExtensionValue",
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Extension value."
},
"ErrorInformation": {
"title": "ErrorInformation",
"type": "object",
"description": "Data model for the complex type ErrorInformation.",
"properties": {
"errorCode": {
"type": "string",
"description": "Specific error number."
},
"errorDescription": {
"type": "string",
"description": "Error description string."
},
"extensionList": {
"$ref": "#/definitions/ExtensionList"
}
},
"required": [
"errorCode",
"errorDescription"
]
},
"ErrorInformationResponse": {
"title": "ErrorInformationResponse",
"type": "object",
"description": "Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.",
"properties": {
"errorInformation": {
"$ref": "#/definitions/ErrorInformation"
}
}
},
"Extension": {
"title": "Extension",
"type": "object",
"description": "Data model for the complex type Extension",
"properties": {
"key": {
"type": "string",
"description": "Extension key."
},
"value": {
"type": "string",
"description": "Extension value."
}
},
"required": [
"key",
"value"
]
},
"ExtensionList": {
"title": "ExtensionList",
"type": "object",
"description": "Data model for the complex type ExtensionList",
"properties": {
"extension": {
"type": "array",
"items": {
"$ref": "#/definitions/Extension"
},
"minItems": 1,
"maxItems": 16,
"description": "Number of Extension elements"
}
},
"required": [
"extension"
]
},
"Status": {
"title": "Status",
"type": "object",
"description": "Data model for the api status.",
"properties": {
"status": {
"type": "string",
"description": "The return current status"
},
"uptime": {
"type": "number",
"description": "Duration that the server is running"
},
"startTime": {
"type": "string",
"description": "Time the server started"
},
"versionNumber": {
"type": "string",
"description": "Current version of the API"
}
}
},
"EventPayload": {
"title": "EventPayload",
"type": "object",
"description": "Data model for the complex type EventPayload.",
"properties": {
"from": {
"type": "string",
"description": "The initiator of the message"
},
"to": {
"type": "string",
"description": "The recipient of the message"
},
"id": {
"type": "string",
"description": "Unique identifier for message"
},
"pp": {
"type": "string",
"description": "Unique identifier for message"
},
"content": {
"$ref": "#/definitions/Content"
},
"type": {
"type": "string",
"description": "The type of the payload i.e. application/json"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
},
"required": [
"from",
"to",
"id",
"type",
"content"
]
},
"Content": {
"title": "Content",
"type": "object",
"description": "Content object in EventPayload",
"properties": {
"headers": {
"$ref": "#/definitions/Headers"
},
"payload": {
"type": "string",
"description": "base 64 encrypted payload for processing"
}
}
},
"Headers": {
"title": "Headers",
"type": "object",
"description": "Headers passed in kafka message",
"properties": {
"content-type": {
"type": "string",
"description": "Content type for message"
},
"date": {
"type": "string",
"description": "A UTC format of the date"
},
"fspiop-source": {
"type": "string",
"description": "The FSP that the message originated from"
},
"fspiop-destination": {
"type": "string",
"description": "The FSP that the message is going to"
}
}
},
"Metadata": {
"title": "Metadata",
"type": "object",
"description": "The metadata of the Kafka message",
"properties": {
"event": {
"$ref": "#/definitions/Event"
},
"trace": {
"$ref": "#/definitions/Trace"
}
},
"required": [
"event",
"trace"
]
},
"Event": {
"title": "Event",
"type": "object",
"description": "The event object of the metadata",
"properties": {
"id": {
"type": "string",
"description": "The FSP that the message is going to"
},
"type": {
"type": "string",
"description": "The FSP that the message is going to"
},
"action": {
"type": "string",
"description": "The FSP that the message is going to"
},
"createdAt": {
"type": "string",
"description": "The FSP that the message is going to"
},
"state": {
"$ref": "#/definitions/State"
},
"responseTo": {
"type": "string",
"description": "Response UUID for previous message"
}
},
"required": [
"id",
"type",
"action",
"createdAt",
"state"
]
},
"Trace": {
"title": "Trace",
"type": "object",
"description": "The trace object for auditing and logging",
"properties": {
"service": {
"type": "string",
"description": "The API the message is going through"
},
"traceId": {
"type": "string",
"description": "The traceId for the span of the message"
},
"parentSpanId": {
"type": "string",
"description": "The parentId of the span"
},
"spanId": {
"type": "string",
"description": "The Id for the span of the process"
},
"timestamp": {
"type": "string",
"description": "The current timestamp of the message"
}
},
"required": [
"service",
"traceId",
"spanId"
]
},
"State": {
"title": "State",
"type": "object",
"description": "The current state of the message",
"properties": {
"status": {
"type": "string",
"description": "The status of the message"
},
"code": {
"type": "number",
"description": "Error code"
},
"description": {
"type": "string",
"description": "The description of the error code"
}
},
"required": [
"status"
]
}
},
"responses": {
"ResponseHealth200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Status"
}
},
"Response201": {
"description": "Created"
},
"Response204": {
"description": "No Content"
},
"ErrorResponse400": {
"description": "Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
},
"ErrorResponse401": {
"description": "Unauthorized - The request requires authentication in order to be processed.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
},
"ErrorResponse403": {
"description": "Forbidden - The request was denied and will be denied in the future.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
},
"ErrorResponse404": {
"description": "Not Found - The resource specified in the URI was not found.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
},
"ErrorResponse405": {
"description": "Method Not Allowed - An unsupported HTTP method for the request was used.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
},
"ErrorResponse406": {
"description": "Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
},
"ErrorResponse501": {
"description": "Not Implemented - The server does not support the requested service. The client should not retry.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
},
"ErrorResponse503": {
"description": "Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.",
"schema": {
"$ref": "#/definitions/ErrorInformationResponse"
},
"headers": {
"Content-Length": {
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.",
"type": "integer"
},
"Content-Type": {
"description": "The Content-Type header indicates the specific version of the API used to send the payload body.",
"type": "string"
}
}
}
},
"parameters": {
"Accept": {
"name": "accept",
"in": "header",
"required": true,
"type": "string",
"description": "The Accept header field indicates the version of the API the client would like the server to use."
},
"Accept-Optional": {
"name": "accept",
"in": "header",
"required": false,
"type": "string",
"description": "The Accept header field indicates the version of the API the client would like the server to use."
},
"Content-Length": {
"name": "content-length",
"in": "header",
"required": false,
"type": "integer",
"description": "The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)"
},
"Content-Type": {
"name": "content-type",
"in": "header",
"type": "string",
"required": true,
"description": "The Content-Type header indicates the specific version of the API used to send the payload body."
},
"Date": {
"name": "date",
"in": "header",
"type": "string",
"required": true,
"description": "The Date header field indicates the date when the request was sent."
}
}
}