/
openapi.yaml
2402 lines (2402 loc) · 64.4 KB
/
openapi.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
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
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: EDC REST API
description: EDC REST APIs - merged by OpenApiMerger
version: 0.0.1-SNAPSHOT
servers:
- url: /
tags:
- name: Data Plane control API
description: 'Api targeted by the Control Plane to delegate a data transfer (Provider
Push or Streaming) to the Data Plane after the contract has been successfully
negotiated and agreed between the two participants. '
- name: Data Plane public API
description: "The public API of the Data Plane is a data proxy enabling a data consumer\
\ to actively querydata from the provider data source (e.g. backend Rest API,\
\ internal database...) through its Data Planeinstance. Thus the Data Plane is\
\ the only entry/output door for the data, which avoids the provider to exposedirectly\
\ its data externally.The Data Plane public API being a proxy, it supports all\
\ verbs (i.e. GET, POST, PUT, PATCH, DELETE), whichcan then conveyed until the\
\ data source is required. This is especially useful when the actual data sourceis\
\ a Rest API itself.In the same manner, any set of arbitrary query parameters,\
\ path parameters and request body are supported (in the limits fixed by the HTTP\
\ server) and can also conveyed to the actual data source."
paths:
/contractagreements:
get:
tags:
- Contract Agreement
description: Gets all contract agreements according to a particular query
operationId: getAllAgreements
parameters:
- name: offset
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: filter
in: query
required: false
style: form
explode: true
schema:
type: string
- name: sort
in: query
required: false
style: form
explode: true
schema:
type: string
enum:
- ASC
- DESC
- name: sortField
in: query
required: false
style: form
explode: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContractAgreementDto'
"400":
description: Request body was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
deprecated: true
/contractagreements/request:
post:
tags:
- Contract Agreement
description: Gets all contract agreements according to a particular query
operationId: queryAllAgreements
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/QuerySpecDto'
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContractAgreementDto'
"400":
description: Request body was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractagreements/{id}:
get:
tags:
- Contract Agreement
description: Gets an contract agreement with the given ID
operationId: getContractAgreement
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: The contract agreement
content:
application/json:
schema:
$ref: '#/components/schemas/ContractAgreementDto'
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: An contract agreement with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractnegotiations:
get:
tags:
- Contract Negotiation
description: Returns all contract negotiations according to a query
operationId: getNegotiations
parameters:
- name: offset
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: filter
in: query
required: false
style: form
explode: true
schema:
type: string
- name: sort
in: query
required: false
style: form
explode: true
schema:
type: string
enum:
- ASC
- DESC
- name: sortField
in: query
required: false
style: form
explode: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContractNegotiationDto'
"400":
description: Request was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
deprecated: true
post:
tags:
- Contract Negotiation
description: "Initiates a contract negotiation for a given offer and with the\
\ given counter part. Please note that successfully invoking this endpoint\
\ only means that the negotiation was initiated. Clients must poll the /{id}/state\
\ endpoint to track the state"
operationId: initiateContractNegotiation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NegotiationInitiateRequestDto'
responses:
"200":
description: The negotiation was successfully initiated. Returns the contract
negotiation ID and created timestamp
content:
application/json:
schema:
$ref: '#/components/schemas/IdResponseDto'
links:
poll-state:
operationId: getNegotiationState
parameters:
id: $response.body#/id
"400":
description: Request body was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractnegotiations/request:
post:
tags:
- Contract Negotiation
description: Returns all contract negotiations according to a query
operationId: queryNegotiations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuerySpecDto'
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContractNegotiationDto'
"400":
description: Request was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractnegotiations/{id}:
get:
tags:
- Contract Negotiation
description: Gets an contract negotiation with the given ID
operationId: getNegotiation
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: The contract negotiation
content:
application/json:
schema:
$ref: '#/components/schemas/ContractNegotiationDto'
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: An contract negotiation with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractnegotiations/{id}/agreement:
get:
tags:
- Contract Negotiation
description: Gets a contract agreement for a contract negotiation with the given
ID
operationId: getAgreementForNegotiation
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: "The contract agreement that is attached to the negotiation,\
\ or null"
content:
application/json:
schema:
$ref: '#/components/schemas/ContractAgreementDto'
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: An contract negotiation with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractnegotiations/{id}/cancel:
post:
tags:
- Contract Negotiation
description: "Requests aborting the contract negotiation. Due to the asynchronous\
\ nature of contract negotiations, a successful response only indicates that\
\ the request was successfully received. Clients must poll the /{id}/state\
\ endpoint to track the state."
operationId: cancelNegotiation
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: Request to cancel the Contract negotiation was successfully
received
links:
poll-state:
operationId: getNegotiationState
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: A contract negotiation with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractnegotiations/{id}/decline:
post:
tags:
- Contract Negotiation
description: "Requests cancelling the contract negotiation. Due to the asynchronous\
\ nature of contract negotiations, a successful response only indicates that\
\ the request was successfully received. Clients must poll the /{id}/state\
\ endpoint to track the state."
operationId: declineNegotiation
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: Request to decline the Contract negotiation was successfully
received
links:
poll-state:
operationId: getNegotiationState
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: A contract negotiation with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractnegotiations/{id}/state:
get:
tags:
- Contract Negotiation
description: Gets the state of a contract negotiation with the given ID
operationId: getNegotiationState
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: The contract negotiation's state
content:
application/json:
schema:
$ref: '#/components/schemas/NegotiationState'
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: An contract negotiation with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/callback/{processId}/deprovision:
post:
tags:
- HTTP Provisioner Webhook
operationId: callDeprovisionWebhook
parameters:
- name: processId
in: path
required: true
style: simple
explode: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeprovisionedResource'
responses:
default:
description: default response
content:
application/json: {}
/callback/{processId}/provision:
post:
tags:
- HTTP Provisioner Webhook
operationId: callProvisionWebhook
parameters:
- name: processId
in: path
required: true
style: simple
explode: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionerWebhookRequest'
responses:
default:
description: default response
content:
application/json: {}
/instances:
get:
tags:
- Dataplane Selector
operationId: getAll
responses:
default:
description: default response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DataPlaneInstance'
post:
tags:
- Dataplane Selector
operationId: addEntry
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataPlaneInstance'
responses:
default:
description: default response
content:
application/json: {}
/instances/select:
post:
tags:
- Dataplane Selector
operationId: find
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SelectionRequest'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DataPlaneInstance'
/policydefinitions:
get:
tags:
- Policy
description: Returns all policy definitions according to a query
operationId: getAllPolicies
parameters:
- name: offset
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: filter
in: query
required: false
style: form
explode: true
schema:
type: string
- name: sort
in: query
required: false
style: form
explode: true
schema:
type: string
enum:
- ASC
- DESC
- name: sortField
in: query
required: false
style: form
explode: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PolicyDefinitionResponseDto'
"400":
description: Request was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
deprecated: true
post:
tags:
- Policy
description: Creates a new policy definition
operationId: createPolicy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyDefinitionRequestDto'
responses:
"200":
description: policy definition was created successfully. Returns the Policy
Definition Id and created timestamp
content:
application/json:
schema:
$ref: '#/components/schemas/IdResponseDto'
"400":
description: Request body was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"409":
description: "Could not create policy definition, because a contract definition\
\ with that ID already exists"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/policydefinitions/request:
post:
tags:
- Policy
description: Returns all policy definitions according to a query
operationId: queryAllPolicies
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuerySpecDto'
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PolicyDefinitionResponseDto'
"400":
description: Request was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/policydefinitions/{id}:
get:
tags:
- Policy
description: Gets a policy definition with the given ID
operationId: getPolicy
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: The policy definition
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyDefinitionResponseDto'
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: An policy definition with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
delete:
tags:
- Policy
description: "Removes a policy definition with the given ID if possible. Deleting\
\ a policy definition is only possible if that policy definition is not yet\
\ referenced by a contract definition, in which case an error is returned.\
\ DANGER ZONE: Note that deleting policy definitions can have unexpected results,\
\ do this at your own risk!"
operationId: deletePolicy
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: Policy definition was deleted successfully
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: An policy definition with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"409":
description: "The policy definition cannot be deleted, because it is referenced\
\ by a contract definition"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/check/health:
get:
tags:
- Application Observability
description: Performs a liveness probe to determine whether the runtime is working
properly.
operationId: checkHealth
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HealthStatus'
/check/liveness:
get:
tags:
- Application Observability
description: Performs a liveness probe to determine whether the runtime is working
properly.
operationId: getLiveness
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HealthStatus'
/check/readiness:
get:
tags:
- Application Observability
description: Performs a readiness probe to determine whether the runtime is
able to accept requests.
operationId: getReadiness
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HealthStatus'
/check/startup:
get:
tags:
- Application Observability
description: Performs a startup probe to determine whether the runtime has completed
startup.
operationId: getStartup
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HealthStatus'
/contractdefinitions:
get:
tags:
- Contract Definition
description: Returns all contract definitions according to a query
operationId: getAllContractDefinitions
parameters:
- name: offset
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: filter
in: query
required: false
style: form
explode: true
schema:
type: string
- name: sort
in: query
required: false
style: form
explode: true
schema:
type: string
enum:
- ASC
- DESC
- name: sortField
in: query
required: false
style: form
explode: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContractDefinitionResponseDto'
"400":
description: Request was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
deprecated: true
post:
tags:
- Contract Definition
description: Creates a new contract definition
operationId: createContractDefinition
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/ContractDefinitionRequestDto'
responses:
"200":
description: contract definition was created successfully. Returns the Contract
Definition Id and created timestamp
content:
application/json:
schema:
$ref: '#/components/schemas/IdResponseDto'
"400":
description: Request body was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"409":
description: "Could not create contract definition, because a contract definition\
\ with that ID already exists"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractdefinitions/request:
post:
tags:
- Contract Definition
description: Returns all contract definitions according to a query
operationId: queryAllContractDefinitions
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/QuerySpecDto'
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContractDefinitionResponseDto'
"400":
description: Request was malformed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
/contractdefinitions/{id}:
get:
tags:
- Contract Definition
description: Gets an contract definition with the given ID
operationId: getContractDefinition
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: The contract definition
content:
application/json:
schema:
$ref: '#/components/schemas/ContractDefinitionResponseDto'
"400":
description: "Request was malformed, e.g. id was null"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
"404":
description: An contract agreement with the given ID does not exist
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiErrorDetail'
delete:
tags:
- Contract Definition
description: "Removes a contract definition with the given ID if possible. DANGER\
\ ZONE: Note that deleting contract definitions can have unexpected results,\
\ especially for contract offers that have been sent out or ongoing or contract\
\ negotiations."
operationId: deleteContractDefinition