forked from open-horizon/edge-sync-service
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.json
3004 lines (3004 loc) · 99 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
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
{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"http"
],
"swagger": "2.0",
"info": {
"description": "The Model Management System (MMS) delivers AI models and other files needed by edge services to the edge nodes where those services are running. MMS has two components, and therefore two APIs: Cloud Sync Service (CSS) is the MMS component that runs on the management hub that users or devops processes use to load models/files into MMS. The Edge Sync Service (ESS) runs on each edge node and is the API that edge services interact with to get the models/files and find out about updates.",
"title": "Model Management System",
"version": "0.0.1"
},
"host": "localhost",
"basePath": "/",
"paths": {
"/api/v1/destinations/{orgID}": {
"get": {
"description": "Provides a list of destinations for an organization, i.e., ESS nodes (belonging to orgID) that have registered with the CSS.\nThis is a CSS only API.",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"CSS"
],
"summary": "List all known destinations.",
"operationId": "handleDestinations",
"parameters": [
{
"type": "string",
"description": "The orgID of the destinations to return.",
"name": "orgID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Destinations response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Destination"
}
}
},
"404": {
"description": "No destinations found",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to retrieve the destinations",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/destinations/{orgID}/{destType}/{destID}/objects": {
"get": {
"description": "Provides a list of objects that are in use by the destination ESS node.\nThis is a CSS only API.",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"CSS"
],
"summary": "List all objects that are in use by the destination.",
"operationId": "handleDestinationObjects",
"parameters": [
{
"type": "string",
"description": "The orgID of the destination to retrieve objects for.",
"name": "orgID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The destType of the destination to retrieve objects for.",
"name": "destType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The destID of the destination to retrieve objects for.",
"name": "destID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Objects response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ObjectStatus"
}
}
},
"404": {
"description": "No objects found",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to retrieve the objects",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/health": {
"get": {
"description": "Get health status of the sync service node.",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"CSS",
"ESS"
],
"summary": "Get health status of the sync service node.",
"operationId": "handleHealth",
"parameters": [
{
"type": "boolean",
"description": "Whether or not to include the detailed health status",
"name": "details",
"in": "query"
}
],
"responses": {
"200": {
"description": "Health status",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/healthReport"
}
}
},
"500": {
"description": "Failed to send health status.",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}": {
"get": {
"description": "Get objects of the specified object type. Either get all of the objects or just those objects that have pending (unconsumed) updates.\nAn application would typically invoke the latter API periodically to check for updates (an alternative is to use a webhook).",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Get objects of the specified type.",
"operationId": "handleListObjects",
"parameters": [
{
"type": "string",
"description": "The object type of the objects to return",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "boolean",
"description": "When returning updated objects only, whether or not to include the objects that have been marked as received by the application",
"name": "received",
"in": "query"
}
],
"responses": {
"200": {
"description": "Updated objects response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MetaData"
}
}
},
"404": {
"description": "No updated objects found",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to retrieve the updated objects",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "Register or delete a webhook for the specified object type.\nA webhook is used to process notifications on updates for objects of the specified object type.",
"consumes": [
"application/json"
],
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Register or delete a webhook.",
"operationId": "handleWebhook",
"parameters": [
{
"type": "string",
"description": "The object type of the objects for the webhook",
"name": "objectType",
"in": "path",
"required": true
},
{
"description": "The webhook's data",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/webhookUpdate"
}
}
],
"responses": {
"204": {
"description": "Webhook registered/deleted",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to update the webhook's data",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}/{objectID}": {
"get": {
"description": "Get the metadata of an object of the specified object type and object ID.\nThe metadata indicates if the objects includes data which can then be obtained using the appropriate API.",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Get an object.",
"operationId": "handleGetObject",
"parameters": [
{
"type": "string",
"description": "The object type of the object to return",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to return",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Object response",
"schema": {
"$ref": "#/definitions/MetaData"
}
},
"404": {
"description": "Object not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to retrieve the object",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "Update/create the object of the specified object type and object ID.\nIf an object with the same type and ID exists that object is updated, otherwise a new object is created.",
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Update/create an object.",
"operationId": "handleUpdateObject",
"parameters": [
{
"type": "string",
"description": "The object type of the object to update/create",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to update/create",
"name": "objectID",
"in": "path",
"required": true
},
{
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/objectUpdate"
}
}
],
"responses": {
"204": {
"description": "Object updated",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to update/create the object",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "Delete the object of the specified object type and object ID.\nDestinations of the object will be notified that the object has been deleted.",
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Delete an object.",
"operationId": "handleDeleteObject",
"parameters": [
{
"type": "string",
"description": "The object type of the object to delete",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to delete",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "Object deleted",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to delete the object",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}/{objectID}/activate": {
"put": {
"description": "Mark the object of the specified object type and object ID as active.\nAn object can be created as inactive which means it is not delivered to its destinations.\nThis API is used to activate such objects and initiate the distribution of the object to its destinations.",
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Mark an object as active.",
"operationId": "handleActivateObject",
"parameters": [
{
"type": "string",
"description": "The object type of the object to mark as active",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to mark as active",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "Object marked as active",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to mark the object active",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}/{objectID}/consumed": {
"put": {
"description": "Mark the object of the specified object type and object ID as having been consumed by the application.\nAfter the object is marked as consumed it will not be delivered to the application again (even if the sync service is restarted).",
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Mark an object as consumed.",
"operationId": "handleObjectConsumed",
"parameters": [
{
"type": "string",
"description": "The object type of the object to mark as consumed",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to mark as consumed",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "Object marked as consumed",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to mark the object consumed",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}/{objectID}/data": {
"get": {
"description": "Get the data of the object of the specified object type and object ID.\nThe metadata of the object indicates if the object includes data (noData is false).",
"produces": [
"application/octet-stream",
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Get the data of an object.",
"operationId": "handleObjectGetData",
"parameters": [
{
"type": "string",
"description": "The object type of the object whose data will be retrieved",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object whose data will be retrieved",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Object data",
"schema": {
"type": "string",
"format": "binary"
}
},
"500": {
"description": "Failed to retrieve the object's data",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "Update the data of the object of the specified object type and object ID.\nThe data can be updated without modifying the object's metadata.",
"consumes": [
"application/octet-stream"
],
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Update the data of an object.",
"operationId": "handleObjectPutData",
"parameters": [
{
"type": "string",
"description": "The object type of the object whose data will be updated",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object whose data will be updated",
"name": "objectID",
"in": "path",
"required": true
},
{
"description": "The object's new data. When read data bytes from a file, please set application/octet-stream as Content-Type in header.",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"type": "string",
"format": "binary"
}
}
],
"responses": {
"204": {
"description": "Object data updated",
"schema": {
"type": "string"
}
},
"404": {
"description": "The specified object doesn't exist",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to update the object's data",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}/{objectID}/received": {
"put": {
"description": "Mark the object of the specified object type and object ID as having been received by the application.\nAfter the object is marked as received it will only be delivered to the application again if specified in the objects request.",
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Mark an object as received.",
"operationId": "handleObjectReceived",
"parameters": [
{
"type": "string",
"description": "The object type of the object to mark as received",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to mark as received",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "Object marked as received",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to mark the object received",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}/{objectID}/status": {
"get": {
"description": "Get the status of the object of the specified object type and object ID.\nThe status can be one of the following:\nnotReady - The object is not ready to be sent to destinations.\nready - The object is ready to be sent to destinations.\nreceived - The object's metadata has been received but not all its data.\ncompletelyReceived - The full object (metadata and data) has been received.\nconsumed - The object has been consumed by the application.\ndeleted - The object was deleted.",
"produces": [
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Get the status of an object.",
"operationId": "handleObjectStatus",
"parameters": [
{
"type": "string",
"description": "The object type of the object whose status will be retrieved",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object whose status will be retrieved",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Object status",
"schema": {
"type": "string",
"enum": [
"notReady",
"ready",
"received",
"completelyReceived",
"consumed",
"deleted"
]
}
},
"500": {
"description": "Failed to retrieve the object's status",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{objectType}?all_objects=true": {
"get": {
"description": "Get all objects of the specified object type that have a destination policy.",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"ESS"
],
"summary": "Get objects with a destination policy of the specified type.",
"operationId": "handleListAllObjects",
"parameters": [
{
"type": "string",
"description": "The object type of the objects to return",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "boolean",
"description": "Whether or not to include all objects. If false only updated objects will be returned.",
"name": "all_objects",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Objects with a destination policy response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ObjectDestinationPolicy"
}
}
},
"404": {
"description": "No objects with a destination policy found",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to retrieve the updated objects",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{orgID}/{objectType}": {
"get": {
"description": "Get objects of the specified object type. Either get all of the objects or just those objects that have pending (unconsumed) updates.\nAn application would typically invoke the latter API periodically to check for updates (an alternative is to use a webhook).",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"CSS"
],
"summary": "Get objects of the specified type.",
"operationId": "handleListObjects",
"parameters": [
{
"type": "string",
"description": "The orgID of the objects to return",
"name": "orgID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object type of the objects to return",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "boolean",
"description": "When returning updated objects only, whether or not to include the objects that have been marked as received by the application",
"name": "received",
"in": "query"
}
],
"responses": {
"200": {
"description": "Updated objects response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MetaData"
}
}
},
"404": {
"description": "No updated objects found",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to retrieve the updated objects",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "Register or delete a webhook for the specified object type.\nA webhook is used to process notifications on updates for objects of the specified object type.",
"consumes": [
"application/json"
],
"produces": [
"text/plain"
],
"tags": [
"CSS"
],
"summary": "Register or delete a webhook.",
"operationId": "handleWebhook",
"parameters": [
{
"type": "string",
"description": "The orgID of the objects for the webhook",
"name": "orgID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object type of the objects for the webhook",
"name": "objectType",
"in": "path",
"required": true
},
{
"description": "The webhook's data",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/webhookUpdate"
}
}
],
"responses": {
"204": {
"description": "Webhook registered/deleted",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to update the webhook's data",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/objects/{orgID}/{objectType}/{objectID}": {
"get": {
"description": "Get the metadata of an object of the specified object type and object ID.\nThe metadata indicates if the objects includes data which can then be obtained using the appropriate API.",
"produces": [
"application/json",
"text/plain"
],
"tags": [
"CSS"
],
"summary": "Get an object.",
"operationId": "handleGetObject",
"parameters": [
{
"type": "string",
"description": "The orgID of the object to return.",
"name": "orgID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object type of the object to return",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to return",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Object response",
"schema": {
"$ref": "#/definitions/MetaData"
}
},
"404": {
"description": "Object not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to retrieve the object",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "Update/create the object of the specified object type and object ID.\nIf an object with the same type and ID exists that object is updated, otherwise a new object is created.",
"produces": [
"text/plain"
],
"tags": [
"CSS"
],
"summary": "Update/create an object.",
"operationId": "handleUpdateObject",
"parameters": [
{
"type": "string",
"description": "The orgID of the object to update/create",
"name": "orgID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object type of the object to update/create",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to update/create",
"name": "objectID",
"in": "path",
"required": true
},
{
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/objectUpdate"
}
}
],
"responses": {
"204": {
"description": "Object updated",
"schema": {
"type": "string"
}
},
"500": {
"description": "Failed to update/create the object",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "Delete the object of the specified object type and object ID.\nDestinations of the object will be notified that the object has been deleted.",
"produces": [
"text/plain"
],
"tags": [
"CSS"
],
"summary": "Delete an object.",
"operationId": "handleDeleteObject",
"parameters": [
{
"type": "string",
"description": "The orgID of the object to delete.",
"name": "orgID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object type of the object to delete",
"name": "objectType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The object ID of the object to delete",
"name": "objectID",
"in": "path",
"required": true
}
],
"responses": {
"204": {