forked from open-horizon/open-horizon.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
exchange_swagger.json
10440 lines (10440 loc) · 313 KB
/
exchange_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
{
"openapi" : "3.0.1",
"info" : {
"title" : "Exchange API",
"description" : "<b>Note:</b> Test the API with curl:<br><br><code>curl -sS -u <org>/iamapikey:<key> https://<host>:<port>/edge-exchange/v1/orgs/... | jq</code></br></br>This API specification is intended to be used by developers",
"termsOfService" : "",
"license" : {
"name" : "Apache License Version 2.0",
"url" : "https://www.apache.org/licenses/LICENSE-2.0"
},
"version" : "2.87.0"
},
"externalDocs" : {
"description" : "Open-horizon ExchangeAPI",
"url" : "https://github.com/open-horizon/exchange-api"
},
"servers" : [ {
"url" : "http://localhost:8080"
}, {
"url" : "https://localhost:8080"
} ],
"security" : [ ],
"paths" : {
"/v1/admin/orgstatus" : {
"get" : {
"tags" : [ "administration" ],
"summary" : "Returns the org-specific status of the Exchange server",
"description" : "Returns a dictionary of statuses/statistics. Can be run by superuser, hub admins, and org admins.",
"operationId" : "adminGetOrgStatusRoute",
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAdminOrgStatusResponse"
}
}
}
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
}
}
}
},
"/v1/admin/status" : {
"get" : {
"tags" : [ "administration" ],
"summary" : "Returns status of the Exchange server",
"description" : "Returns a dictionary of statuses/statistics. Can be run by any user.",
"operationId" : "adminGetStatusRoute",
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAdminStatusResponse"
}
}
}
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
}
}
}
},
"/v1/admin/version" : {
"get" : {
"tags" : [ "administration" ],
"summary" : "Returns the version of the Exchange server",
"description" : "Returns the version of the Exchange server as a simple string (no JSON or quotes). Can be run by anyone.",
"operationId" : "adminGetVersionRoute",
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/v1/admin/hashpw" : {
"post" : {
"tags" : [ "administration" ],
"summary" : "Returns a bcrypted hash of a password",
"description" : "Takes the password specified in the request body, bcrypts it with a random salt, and returns the result. This can be useful if you want to specify root's hash pw in the config file instead of the clear pw.",
"operationId" : "adminHashPwRoute",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AdminHashpwRequest"
},
"example" : {
"password" : "pw to bcrypt"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApiResponse"
}
}
}
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
}
}
}
},
"/v1/orgs/{orgid}/agbots/{id}/businesspols/{buspolid}" : {
"get" : {
"tags" : [ "agreement-bot/policy" ],
"summary" : "Returns a business policy this agbot is serving",
"description" : "Returns the business policy with the specified patid for the specified agbot id. The patid should be in the form businessPolOrgid_businessPol. Can be run by the owning user or the agbot.",
"operationId" : "agbotGetBusPolRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "buspolid",
"in" : "path",
"description" : "ID of the business policy.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAgbotBusinessPolsResponse"
},
"example" : {
"businessPols" : {
"buspolid" : {
"businessPolOrgid" : "string",
"businessPol" : "string",
"nodeOrgid" : "string",
"lastUpdated" : "string"
}
}
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"delete" : {
"tags" : [ "agreement-bot/policy" ],
"summary" : "Deletes a business policy of an agbot",
"description" : "Deletes a business policy that this agbot was serving. Can be run by the owning user or the agbot.",
"operationId" : "agbotDeleteBusPolRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "buspolid",
"in" : "path",
"description" : "ID of the business policy to be deleted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "deleted"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
}
},
"/v1/orgs/{orgid}/agbots/{id}/businesspols" : {
"get" : {
"tags" : [ "agreement-bot/policy" ],
"summary" : "Returns all business policies served by this agbot",
"description" : "Returns all business policies that this agbot is finding nodes for to make agreements with them. Can be run by the owning user or the agbot.",
"operationId" : "agbotGetBusPolsRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAgbotBusinessPolsResponse"
},
"example" : {
"businessPols" : {
"buspolid" : {
"businessPolOrgid" : "string",
"businessPol" : "string",
"nodeOrgid" : "string",
"lastUpdated" : "string"
}
}
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"post" : {
"tags" : [ "agreement-bot/policy" ],
"summary" : "Adds a business policy that the agbot should serve",
"description" : "Adds a new business policy and node org that this agbot should find nodes for to make agreements with them. This is called by the owning user or the agbot to give their information about the business policy.",
"operationId" : "agbotPostBusPolRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PostAgbotBusinessPolRequest"
},
"example" : {
"businessPolOrgid" : "string",
"businessPol" : "string",
"nodeOrgid" : "string"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApiResponse"
}
}
}
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"delete" : {
"tags" : [ "agreement-bot/policy" ],
"summary" : "Deletes all business policies of an agbot",
"description" : "Deletes all of the current business policies that this agbot was serving. Can be run by the owning user or the agbot.",
"operationId" : "agbotDeleteBusPolsRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "deleted"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
}
},
"/v1/orgs/{orgid}/agbots/{id}/msgs/{msgid}" : {
"get" : {
"tags" : [ "agreement-bot/message" ],
"summary" : "Returns A specific message that has been sent to this agreement-bot.",
"description" : "Returns A specific message that has been sent to this agreement-bot. Deleted/post-TTL (Time To Live) messages will not be returned. Can be run by a user or the agbot.",
"operationId" : "agbotGetMsgRoute",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Agreement-bot id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "msgid",
"in" : "path",
"description" : "Message id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAgbotMsgsResponse"
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"delete" : {
"tags" : [ "agreement-bot/message" ],
"summary" : "Deletes a msg of an agbot",
"description" : "Deletes a message that was sent to an agbot. This should be done by the agbot after each msg is read. Can be run by the owning user or the agbot.",
"operationId" : "agbotDeleteMsgRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "msgid",
"in" : "path",
"description" : "ID of the msg to be deleted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "deleted"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
}
},
"/v1/orgs/{orgid}/agbots/{id}/patterns/{patid}" : {
"get" : {
"tags" : [ "agreement-bot/pattern" ],
"summary" : "Returns a pattern this agbot is serving",
"description" : "Returns the pattern with the specified patid for the specified agbot id. The patid should be in the form patternOrgid_pattern. Can be run by the owning user or the agbot.",
"operationId" : "agbotGetPatternRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "patid",
"in" : "path",
"description" : "ID of the pattern.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAgbotPatternsResponse"
},
"example" : {
"patterns" : {
"patternname" : {
"patternOrgid" : "string",
"pattern" : "string",
"nodeOrgid" : "string",
"lastUpdated" : "2019-05-14T16:34:36.397Z[UTC]"
}
}
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"delete" : {
"tags" : [ "agreement-bot/pattern" ],
"summary" : "Deletes a pattern of an agbot",
"description" : "Deletes a pattern that this agbot was serving. Can be run by the owning user or the agbot.",
"operationId" : "agbotDeletePatRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "patid",
"in" : "path",
"description" : "ID of the pattern to be deleted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "deleted"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
}
},
"/v1/orgs/{orgid}/agbots/{id}/patterns" : {
"get" : {
"tags" : [ "agreement-bot/pattern" ],
"summary" : "Returns all patterns served by this agbot",
"description" : "Returns all patterns that this agbot is finding nodes for to make agreements with them. Can be run by the owning user or the agbot.",
"operationId" : "agbotGetPatternsRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAgbotPatternsResponse"
},
"example" : {
"patterns" : {
"pattern1" : {
"patternOrgid" : "string",
"pattern" : "string",
"nodeOrgid" : "string",
"lastUpdated" : "2019-05-14T16:34:36.295Z[UTC]"
},
"pattern2" : {
"patternOrgid" : "string",
"pattern" : "string",
"nodeOrgid" : "string",
"lastUpdated" : "2019-05-14T16:34:36.397Z[UTC]"
}
}
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"post" : {
"tags" : [ "agreement-bot/pattern" ],
"summary" : "Adds a pattern that the agbot should serve",
"description" : "Adds a new pattern and node org that this agbot should find nodes for to make agreements with them. This is called by the owning user or the agbot to give their information about the pattern.",
"operationId" : "agbotPostPatRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PostAgbotPatternRequest"
},
"example" : {
"patternOrgid" : "string",
"pattern" : "string",
"nodeOrgid" : "string"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApiResponse"
}
}
}
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"delete" : {
"tags" : [ "agreement-bot/pattern" ],
"summary" : "Deletes all patterns of an agbot",
"description" : "Deletes all of the current patterns that this agbot was serving. Can be run by the owning user or the agbot.",
"operationId" : "agbotDeletePatsRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "deleted"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
}
},
"/v1/orgs/{orgid}/agbots/{id}" : {
"get" : {
"tags" : [ "agreement-bot" ],
"summary" : "Returns an agbot",
"description" : "Returns the agbot (Agreement Bot) with the specified id. Can be run by a user or the agbot.",
"operationId" : "agbotGetRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attribute",
"in" : "query",
"description" : "Which attribute value should be returned. Only 1 attribute can be specified. If not specified, the entire node resource (including services) will be returned",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "response body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAgbotsResponse"
},
"example" : {
"agbots" : {
"orgid/agbotname" : {
"token" : "string",
"name" : "string",
"owner" : "string",
"msgEndPoint" : "",
"lastHeartbeat" : "2020-05-27T19:01:10.713Z[UTC]",
"publicKey" : "string"
}
},
"lastIndex" : 0
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"put" : {
"tags" : [ "agreement-bot" ],
"summary" : "Add/updates an agbot",
"description" : "Adds a new agbot (Agreement Bot) to the exchange DB, or updates an existing agbot. This must be called by the user to add an agbot, and then can be called by that user or agbot to update itself.",
"operationId" : "agbotPutRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PutAgbotsRequest"
},
"example" : {
"token" : "abc",
"name" : "myagbot",
"publicKey" : "ABCDEF"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "resource add/updated - response body:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApiResponse"
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"delete" : {
"tags" : [ "agreement-bot" ],
"summary" : "Deletes an agbot",
"description" : "Deletes an agbot (Agreement Bot), and deletes the agreements stored for this agbot (but does not actually cancel the agreements between the nodes and agbot). Can be run by the owning user or the agbot.",
"operationId" : "agbotDeleteRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "deleted"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {
"description" : "access denied"
},
"404" : {
"description" : "not found"
}
}
},
"patch" : {
"tags" : [ "agreement-bot" ],
"summary" : "Updates 1 attribute of an agbot",
"description" : "Updates some attributes of an agbot. This can be called by the user or the agbot.",
"operationId" : "agbotPatchRoute",
"parameters" : [ {
"name" : "orgid",
"in" : "path",
"description" : "Organization id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "ID of the agbot.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Specify only **one** of the following attributes",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PatchAgbotsRequest"
},
"example" : {
"token" : "abc",
"name" : "myagbot",
"msgEndPoint" : "string",
"publicKey" : "ABCDEF"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "resource updated - response body:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApiResponse"
}
}
}
},
"400" : {
"description" : "bad input"
},
"401" : {
"description" : "invalid credentials"
},
"403" : {