@twin.org/identity-service 0.0.3-next.1 → 0.0.3-next.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -70,6 +70,45 @@
70
70
  }
71
71
  }
72
72
  }
73
+ },
74
+ "400": {
75
+ "description": "The server cannot process the request, see the content for more details.",
76
+ "content": {
77
+ "application/json": {
78
+ "schema": {
79
+ "$ref": "#/components/schemas/Error"
80
+ },
81
+ "examples": {
82
+ "exampleResponse": {
83
+ "value": {
84
+ "name": "GeneralError",
85
+ "message": "errorMessage",
86
+ "properties": {
87
+ "foo": "bar"
88
+ }
89
+ }
90
+ }
91
+ }
92
+ }
93
+ }
94
+ },
95
+ "500": {
96
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
97
+ "content": {
98
+ "application/json": {
99
+ "schema": {
100
+ "$ref": "#/components/schemas/Error"
101
+ },
102
+ "examples": {
103
+ "exampleResponse": {
104
+ "value": {
105
+ "name": "InternalServerError",
106
+ "message": "errorMessage"
107
+ }
108
+ }
109
+ }
110
+ }
111
+ }
73
112
  }
74
113
  }
75
114
  },
@@ -98,12 +137,62 @@
98
137
  }
99
138
  ],
100
139
  "responses": {
101
- "200": {
102
- "description": "The rest request ended in success with no data.",
140
+ "204": {
141
+ "description": "The rest request ended in success with no data."
142
+ },
143
+ "400": {
144
+ "description": "The server cannot process the request, see the content for more details.",
145
+ "content": {
146
+ "application/json": {
147
+ "schema": {
148
+ "$ref": "#/components/schemas/Error"
149
+ },
150
+ "examples": {
151
+ "exampleResponse": {
152
+ "value": {
153
+ "name": "GeneralError",
154
+ "message": "errorMessage",
155
+ "properties": {
156
+ "foo": "bar"
157
+ }
158
+ }
159
+ }
160
+ }
161
+ }
162
+ }
163
+ },
164
+ "401": {
165
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
166
+ "content": {
167
+ "application/json": {
168
+ "schema": {
169
+ "$ref": "#/components/schemas/Error"
170
+ },
171
+ "examples": {
172
+ "exampleResponse": {
173
+ "value": {
174
+ "name": "UnauthorizedError",
175
+ "message": "errorMessage"
176
+ }
177
+ }
178
+ }
179
+ }
180
+ }
181
+ },
182
+ "500": {
183
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
103
184
  "content": {
104
- "text/plain": {
185
+ "application/json": {
105
186
  "schema": {
106
- "$ref": "#/components/schemas/NoContentResponse"
187
+ "$ref": "#/components/schemas/Error"
188
+ },
189
+ "examples": {
190
+ "exampleResponse": {
191
+ "value": {
192
+ "name": "InternalServerError",
193
+ "message": "errorMessage"
194
+ }
195
+ }
107
196
  }
108
197
  }
109
198
  }
@@ -159,6 +248,63 @@
159
248
  }
160
249
  }
161
250
  }
251
+ },
252
+ "400": {
253
+ "description": "The server cannot process the request, see the content for more details.",
254
+ "content": {
255
+ "application/json": {
256
+ "schema": {
257
+ "$ref": "#/components/schemas/Error"
258
+ },
259
+ "examples": {
260
+ "exampleResponse": {
261
+ "value": {
262
+ "name": "GeneralError",
263
+ "message": "errorMessage",
264
+ "properties": {
265
+ "foo": "bar"
266
+ }
267
+ }
268
+ }
269
+ }
270
+ }
271
+ }
272
+ },
273
+ "401": {
274
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
275
+ "content": {
276
+ "application/json": {
277
+ "schema": {
278
+ "$ref": "#/components/schemas/Error"
279
+ },
280
+ "examples": {
281
+ "exampleResponse": {
282
+ "value": {
283
+ "name": "UnauthorizedError",
284
+ "message": "errorMessage"
285
+ }
286
+ }
287
+ }
288
+ }
289
+ }
290
+ },
291
+ "500": {
292
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
293
+ "content": {
294
+ "application/json": {
295
+ "schema": {
296
+ "$ref": "#/components/schemas/Error"
297
+ },
298
+ "examples": {
299
+ "exampleResponse": {
300
+ "value": {
301
+ "name": "InternalServerError",
302
+ "message": "errorMessage"
303
+ }
304
+ }
305
+ }
306
+ }
307
+ }
162
308
  }
163
309
  }
164
310
  }
@@ -233,6 +379,63 @@
233
379
  }
234
380
  }
235
381
  }
382
+ },
383
+ "400": {
384
+ "description": "The server cannot process the request, see the content for more details.",
385
+ "content": {
386
+ "application/json": {
387
+ "schema": {
388
+ "$ref": "#/components/schemas/Error"
389
+ },
390
+ "examples": {
391
+ "exampleResponse": {
392
+ "value": {
393
+ "name": "GeneralError",
394
+ "message": "errorMessage",
395
+ "properties": {
396
+ "foo": "bar"
397
+ }
398
+ }
399
+ }
400
+ }
401
+ }
402
+ }
403
+ },
404
+ "401": {
405
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
406
+ "content": {
407
+ "application/json": {
408
+ "schema": {
409
+ "$ref": "#/components/schemas/Error"
410
+ },
411
+ "examples": {
412
+ "exampleResponse": {
413
+ "value": {
414
+ "name": "UnauthorizedError",
415
+ "message": "errorMessage"
416
+ }
417
+ }
418
+ }
419
+ }
420
+ }
421
+ },
422
+ "500": {
423
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
424
+ "content": {
425
+ "application/json": {
426
+ "schema": {
427
+ "$ref": "#/components/schemas/Error"
428
+ },
429
+ "examples": {
430
+ "exampleResponse": {
431
+ "value": {
432
+ "name": "InternalServerError",
433
+ "message": "errorMessage"
434
+ }
435
+ }
436
+ }
437
+ }
438
+ }
236
439
  }
237
440
  }
238
441
  }
@@ -274,12 +477,62 @@
274
477
  }
275
478
  ],
276
479
  "responses": {
277
- "200": {
278
- "description": "The rest request ended in success with no data.",
480
+ "204": {
481
+ "description": "The rest request ended in success with no data."
482
+ },
483
+ "400": {
484
+ "description": "The server cannot process the request, see the content for more details.",
485
+ "content": {
486
+ "application/json": {
487
+ "schema": {
488
+ "$ref": "#/components/schemas/Error"
489
+ },
490
+ "examples": {
491
+ "exampleResponse": {
492
+ "value": {
493
+ "name": "GeneralError",
494
+ "message": "errorMessage",
495
+ "properties": {
496
+ "foo": "bar"
497
+ }
498
+ }
499
+ }
500
+ }
501
+ }
502
+ }
503
+ },
504
+ "401": {
505
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
506
+ "content": {
507
+ "application/json": {
508
+ "schema": {
509
+ "$ref": "#/components/schemas/Error"
510
+ },
511
+ "examples": {
512
+ "exampleResponse": {
513
+ "value": {
514
+ "name": "UnauthorizedError",
515
+ "message": "errorMessage"
516
+ }
517
+ }
518
+ }
519
+ }
520
+ }
521
+ },
522
+ "500": {
523
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
279
524
  "content": {
280
- "text/plain": {
525
+ "application/json": {
281
526
  "schema": {
282
- "$ref": "#/components/schemas/NoContentResponse"
527
+ "$ref": "#/components/schemas/Error"
528
+ },
529
+ "examples": {
530
+ "exampleResponse": {
531
+ "value": {
532
+ "name": "InternalServerError",
533
+ "message": "errorMessage"
534
+ }
535
+ }
283
536
  }
284
537
  }
285
538
  }
@@ -351,6 +604,63 @@
351
604
  }
352
605
  }
353
606
  }
607
+ },
608
+ "400": {
609
+ "description": "The server cannot process the request, see the content for more details.",
610
+ "content": {
611
+ "application/json": {
612
+ "schema": {
613
+ "$ref": "#/components/schemas/Error"
614
+ },
615
+ "examples": {
616
+ "exampleResponse": {
617
+ "value": {
618
+ "name": "GeneralError",
619
+ "message": "errorMessage",
620
+ "properties": {
621
+ "foo": "bar"
622
+ }
623
+ }
624
+ }
625
+ }
626
+ }
627
+ }
628
+ },
629
+ "401": {
630
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
631
+ "content": {
632
+ "application/json": {
633
+ "schema": {
634
+ "$ref": "#/components/schemas/Error"
635
+ },
636
+ "examples": {
637
+ "exampleResponse": {
638
+ "value": {
639
+ "name": "UnauthorizedError",
640
+ "message": "errorMessage"
641
+ }
642
+ }
643
+ }
644
+ }
645
+ }
646
+ },
647
+ "500": {
648
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
649
+ "content": {
650
+ "application/json": {
651
+ "schema": {
652
+ "$ref": "#/components/schemas/Error"
653
+ },
654
+ "examples": {
655
+ "exampleResponse": {
656
+ "value": {
657
+ "name": "InternalServerError",
658
+ "message": "errorMessage"
659
+ }
660
+ }
661
+ }
662
+ }
663
+ }
354
664
  }
355
665
  }
356
666
  }
@@ -392,12 +702,62 @@
392
702
  }
393
703
  ],
394
704
  "responses": {
395
- "200": {
396
- "description": "The rest request ended in success with no data.",
705
+ "204": {
706
+ "description": "The rest request ended in success with no data."
707
+ },
708
+ "400": {
709
+ "description": "The server cannot process the request, see the content for more details.",
710
+ "content": {
711
+ "application/json": {
712
+ "schema": {
713
+ "$ref": "#/components/schemas/Error"
714
+ },
715
+ "examples": {
716
+ "exampleResponse": {
717
+ "value": {
718
+ "name": "GeneralError",
719
+ "message": "errorMessage",
720
+ "properties": {
721
+ "foo": "bar"
722
+ }
723
+ }
724
+ }
725
+ }
726
+ }
727
+ }
728
+ },
729
+ "401": {
730
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
731
+ "content": {
732
+ "application/json": {
733
+ "schema": {
734
+ "$ref": "#/components/schemas/Error"
735
+ },
736
+ "examples": {
737
+ "exampleResponse": {
738
+ "value": {
739
+ "name": "UnauthorizedError",
740
+ "message": "errorMessage"
741
+ }
742
+ }
743
+ }
744
+ }
745
+ }
746
+ },
747
+ "500": {
748
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
397
749
  "content": {
398
- "text/plain": {
750
+ "application/json": {
399
751
  "schema": {
400
- "$ref": "#/components/schemas/NoContentResponse"
752
+ "$ref": "#/components/schemas/Error"
753
+ },
754
+ "examples": {
755
+ "exampleResponse": {
756
+ "value": {
757
+ "name": "InternalServerError",
758
+ "message": "errorMessage"
759
+ }
760
+ }
401
761
  }
402
762
  }
403
763
  }
@@ -505,27 +865,84 @@
505
865
  }
506
866
  }
507
867
  }
508
- }
509
- }
510
- }
511
- },
512
- "/identity/verifiable-credential/verify": {
513
- "get": {
514
- "operationId": "identityVerifiableCredentialVerify",
515
- "summary": "Verify an identity verifiable credential",
516
- "tags": [
517
- "Identity"
518
- ],
519
- "parameters": [
520
- {
521
- "name": "jwt",
522
- "description": "The jwt to verify.",
523
- "in": "query",
524
- "required": false,
525
- "schema": {
526
- "type": "string"
527
- },
528
- "example": "eyJraWQiOi...D1Z3AQ"
868
+ },
869
+ "400": {
870
+ "description": "The server cannot process the request, see the content for more details.",
871
+ "content": {
872
+ "application/json": {
873
+ "schema": {
874
+ "$ref": "#/components/schemas/Error"
875
+ },
876
+ "examples": {
877
+ "exampleResponse": {
878
+ "value": {
879
+ "name": "GeneralError",
880
+ "message": "errorMessage",
881
+ "properties": {
882
+ "foo": "bar"
883
+ }
884
+ }
885
+ }
886
+ }
887
+ }
888
+ }
889
+ },
890
+ "401": {
891
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
892
+ "content": {
893
+ "application/json": {
894
+ "schema": {
895
+ "$ref": "#/components/schemas/Error"
896
+ },
897
+ "examples": {
898
+ "exampleResponse": {
899
+ "value": {
900
+ "name": "UnauthorizedError",
901
+ "message": "errorMessage"
902
+ }
903
+ }
904
+ }
905
+ }
906
+ }
907
+ },
908
+ "500": {
909
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
910
+ "content": {
911
+ "application/json": {
912
+ "schema": {
913
+ "$ref": "#/components/schemas/Error"
914
+ },
915
+ "examples": {
916
+ "exampleResponse": {
917
+ "value": {
918
+ "name": "InternalServerError",
919
+ "message": "errorMessage"
920
+ }
921
+ }
922
+ }
923
+ }
924
+ }
925
+ }
926
+ }
927
+ }
928
+ },
929
+ "/identity/verifiable-credential/verify": {
930
+ "get": {
931
+ "operationId": "identityVerifiableCredentialVerify",
932
+ "summary": "Verify an identity verifiable credential",
933
+ "tags": [
934
+ "Identity"
935
+ ],
936
+ "parameters": [
937
+ {
938
+ "name": "jwt",
939
+ "description": "The jwt to verify.",
940
+ "in": "query",
941
+ "required": false,
942
+ "schema": {
943
+ "type": "string"
944
+ },
945
+ "example": "eyJraWQiOi...D1Z3AQ"
529
946
  }
530
947
  ],
531
948
  "responses": {
@@ -567,6 +984,45 @@
567
984
  }
568
985
  }
569
986
  }
987
+ },
988
+ "400": {
989
+ "description": "The server cannot process the request, see the content for more details.",
990
+ "content": {
991
+ "application/json": {
992
+ "schema": {
993
+ "$ref": "#/components/schemas/Error"
994
+ },
995
+ "examples": {
996
+ "exampleResponse": {
997
+ "value": {
998
+ "name": "GeneralError",
999
+ "message": "errorMessage",
1000
+ "properties": {
1001
+ "foo": "bar"
1002
+ }
1003
+ }
1004
+ }
1005
+ }
1006
+ }
1007
+ }
1008
+ },
1009
+ "500": {
1010
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
1011
+ "content": {
1012
+ "application/json": {
1013
+ "schema": {
1014
+ "$ref": "#/components/schemas/Error"
1015
+ },
1016
+ "examples": {
1017
+ "exampleResponse": {
1018
+ "value": {
1019
+ "name": "InternalServerError",
1020
+ "message": "errorMessage"
1021
+ }
1022
+ }
1023
+ }
1024
+ }
1025
+ }
570
1026
  }
571
1027
  }
572
1028
  }
@@ -596,10 +1052,10 @@
596
1052
  "in": "path",
597
1053
  "required": true,
598
1054
  "schema": {
599
- "type": "number"
1055
+ "type": "string"
600
1056
  },
601
1057
  "style": "simple",
602
- "example": 5
1058
+ "example": "5"
603
1059
  }
604
1060
  ],
605
1061
  "security": [
@@ -608,12 +1064,62 @@
608
1064
  }
609
1065
  ],
610
1066
  "responses": {
611
- "200": {
612
- "description": "The rest request ended in success with no data.",
1067
+ "204": {
1068
+ "description": "The rest request ended in success with no data."
1069
+ },
1070
+ "400": {
1071
+ "description": "The server cannot process the request, see the content for more details.",
1072
+ "content": {
1073
+ "application/json": {
1074
+ "schema": {
1075
+ "$ref": "#/components/schemas/Error"
1076
+ },
1077
+ "examples": {
1078
+ "exampleResponse": {
1079
+ "value": {
1080
+ "name": "GeneralError",
1081
+ "message": "errorMessage",
1082
+ "properties": {
1083
+ "foo": "bar"
1084
+ }
1085
+ }
1086
+ }
1087
+ }
1088
+ }
1089
+ }
1090
+ },
1091
+ "401": {
1092
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
1093
+ "content": {
1094
+ "application/json": {
1095
+ "schema": {
1096
+ "$ref": "#/components/schemas/Error"
1097
+ },
1098
+ "examples": {
1099
+ "exampleResponse": {
1100
+ "value": {
1101
+ "name": "UnauthorizedError",
1102
+ "message": "errorMessage"
1103
+ }
1104
+ }
1105
+ }
1106
+ }
1107
+ }
1108
+ },
1109
+ "500": {
1110
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
613
1111
  "content": {
614
- "text/plain": {
1112
+ "application/json": {
615
1113
  "schema": {
616
- "$ref": "#/components/schemas/NoContentResponse"
1114
+ "$ref": "#/components/schemas/Error"
1115
+ },
1116
+ "examples": {
1117
+ "exampleResponse": {
1118
+ "value": {
1119
+ "name": "InternalServerError",
1120
+ "message": "errorMessage"
1121
+ }
1122
+ }
617
1123
  }
618
1124
  }
619
1125
  }
@@ -646,10 +1152,10 @@
646
1152
  "in": "path",
647
1153
  "required": true,
648
1154
  "schema": {
649
- "type": "number"
1155
+ "type": "string"
650
1156
  },
651
1157
  "style": "simple",
652
- "example": 5
1158
+ "example": "5"
653
1159
  }
654
1160
  ],
655
1161
  "security": [
@@ -658,12 +1164,62 @@
658
1164
  }
659
1165
  ],
660
1166
  "responses": {
661
- "200": {
662
- "description": "The rest request ended in success with no data.",
1167
+ "204": {
1168
+ "description": "The rest request ended in success with no data."
1169
+ },
1170
+ "400": {
1171
+ "description": "The server cannot process the request, see the content for more details.",
1172
+ "content": {
1173
+ "application/json": {
1174
+ "schema": {
1175
+ "$ref": "#/components/schemas/Error"
1176
+ },
1177
+ "examples": {
1178
+ "exampleResponse": {
1179
+ "value": {
1180
+ "name": "GeneralError",
1181
+ "message": "errorMessage",
1182
+ "properties": {
1183
+ "foo": "bar"
1184
+ }
1185
+ }
1186
+ }
1187
+ }
1188
+ }
1189
+ }
1190
+ },
1191
+ "401": {
1192
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
1193
+ "content": {
1194
+ "application/json": {
1195
+ "schema": {
1196
+ "$ref": "#/components/schemas/Error"
1197
+ },
1198
+ "examples": {
1199
+ "exampleResponse": {
1200
+ "value": {
1201
+ "name": "UnauthorizedError",
1202
+ "message": "errorMessage"
1203
+ }
1204
+ }
1205
+ }
1206
+ }
1207
+ }
1208
+ },
1209
+ "500": {
1210
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
663
1211
  "content": {
664
- "text/plain": {
1212
+ "application/json": {
665
1213
  "schema": {
666
- "$ref": "#/components/schemas/NoContentResponse"
1214
+ "$ref": "#/components/schemas/Error"
1215
+ },
1216
+ "examples": {
1217
+ "exampleResponse": {
1218
+ "value": {
1219
+ "name": "InternalServerError",
1220
+ "message": "errorMessage"
1221
+ }
1222
+ }
667
1223
  }
668
1224
  }
669
1225
  }
@@ -760,6 +1316,63 @@
760
1316
  }
761
1317
  }
762
1318
  }
1319
+ },
1320
+ "400": {
1321
+ "description": "The server cannot process the request, see the content for more details.",
1322
+ "content": {
1323
+ "application/json": {
1324
+ "schema": {
1325
+ "$ref": "#/components/schemas/Error"
1326
+ },
1327
+ "examples": {
1328
+ "exampleResponse": {
1329
+ "value": {
1330
+ "name": "GeneralError",
1331
+ "message": "errorMessage",
1332
+ "properties": {
1333
+ "foo": "bar"
1334
+ }
1335
+ }
1336
+ }
1337
+ }
1338
+ }
1339
+ }
1340
+ },
1341
+ "401": {
1342
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
1343
+ "content": {
1344
+ "application/json": {
1345
+ "schema": {
1346
+ "$ref": "#/components/schemas/Error"
1347
+ },
1348
+ "examples": {
1349
+ "exampleResponse": {
1350
+ "value": {
1351
+ "name": "UnauthorizedError",
1352
+ "message": "errorMessage"
1353
+ }
1354
+ }
1355
+ }
1356
+ }
1357
+ }
1358
+ },
1359
+ "500": {
1360
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
1361
+ "content": {
1362
+ "application/json": {
1363
+ "schema": {
1364
+ "$ref": "#/components/schemas/Error"
1365
+ },
1366
+ "examples": {
1367
+ "exampleResponse": {
1368
+ "value": {
1369
+ "name": "InternalServerError",
1370
+ "message": "errorMessage"
1371
+ }
1372
+ }
1373
+ }
1374
+ }
1375
+ }
763
1376
  }
764
1377
  }
765
1378
  }
@@ -815,6 +1428,45 @@
815
1428
  }
816
1429
  }
817
1430
  }
1431
+ },
1432
+ "400": {
1433
+ "description": "The server cannot process the request, see the content for more details.",
1434
+ "content": {
1435
+ "application/json": {
1436
+ "schema": {
1437
+ "$ref": "#/components/schemas/Error"
1438
+ },
1439
+ "examples": {
1440
+ "exampleResponse": {
1441
+ "value": {
1442
+ "name": "GeneralError",
1443
+ "message": "errorMessage",
1444
+ "properties": {
1445
+ "foo": "bar"
1446
+ }
1447
+ }
1448
+ }
1449
+ }
1450
+ }
1451
+ }
1452
+ },
1453
+ "500": {
1454
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
1455
+ "content": {
1456
+ "application/json": {
1457
+ "schema": {
1458
+ "$ref": "#/components/schemas/Error"
1459
+ },
1460
+ "examples": {
1461
+ "exampleResponse": {
1462
+ "value": {
1463
+ "name": "InternalServerError",
1464
+ "message": "errorMessage"
1465
+ }
1466
+ }
1467
+ }
1468
+ }
1469
+ }
818
1470
  }
819
1471
  }
820
1472
  }
@@ -918,6 +1570,63 @@
918
1570
  }
919
1571
  }
920
1572
  }
1573
+ },
1574
+ "400": {
1575
+ "description": "The server cannot process the request, see the content for more details.",
1576
+ "content": {
1577
+ "application/json": {
1578
+ "schema": {
1579
+ "$ref": "#/components/schemas/Error"
1580
+ },
1581
+ "examples": {
1582
+ "exampleResponse": {
1583
+ "value": {
1584
+ "name": "GeneralError",
1585
+ "message": "errorMessage",
1586
+ "properties": {
1587
+ "foo": "bar"
1588
+ }
1589
+ }
1590
+ }
1591
+ }
1592
+ }
1593
+ }
1594
+ },
1595
+ "401": {
1596
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
1597
+ "content": {
1598
+ "application/json": {
1599
+ "schema": {
1600
+ "$ref": "#/components/schemas/Error"
1601
+ },
1602
+ "examples": {
1603
+ "exampleResponse": {
1604
+ "value": {
1605
+ "name": "UnauthorizedError",
1606
+ "message": "errorMessage"
1607
+ }
1608
+ }
1609
+ }
1610
+ }
1611
+ }
1612
+ },
1613
+ "500": {
1614
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
1615
+ "content": {
1616
+ "application/json": {
1617
+ "schema": {
1618
+ "$ref": "#/components/schemas/Error"
1619
+ },
1620
+ "examples": {
1621
+ "exampleResponse": {
1622
+ "value": {
1623
+ "name": "InternalServerError",
1624
+ "message": "errorMessage"
1625
+ }
1626
+ }
1627
+ }
1628
+ }
1629
+ }
921
1630
  }
922
1631
  }
923
1632
  }
@@ -991,12 +1700,51 @@
991
1700
  }
992
1701
  }
993
1702
  }
994
- }
995
- }
996
- }
997
- },
998
- "/identity/profile": {
999
- "post": {
1703
+ },
1704
+ "400": {
1705
+ "description": "The server cannot process the request, see the content for more details.",
1706
+ "content": {
1707
+ "application/json": {
1708
+ "schema": {
1709
+ "$ref": "#/components/schemas/Error"
1710
+ },
1711
+ "examples": {
1712
+ "exampleResponse": {
1713
+ "value": {
1714
+ "name": "GeneralError",
1715
+ "message": "errorMessage",
1716
+ "properties": {
1717
+ "foo": "bar"
1718
+ }
1719
+ }
1720
+ }
1721
+ }
1722
+ }
1723
+ }
1724
+ },
1725
+ "500": {
1726
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
1727
+ "content": {
1728
+ "application/json": {
1729
+ "schema": {
1730
+ "$ref": "#/components/schemas/Error"
1731
+ },
1732
+ "examples": {
1733
+ "exampleResponse": {
1734
+ "value": {
1735
+ "name": "InternalServerError",
1736
+ "message": "errorMessage"
1737
+ }
1738
+ }
1739
+ }
1740
+ }
1741
+ }
1742
+ }
1743
+ }
1744
+ }
1745
+ },
1746
+ "/identity/profile": {
1747
+ "post": {
1000
1748
  "operationId": "identityProfileCreate",
1001
1749
  "summary": "Create an identity profile",
1002
1750
  "tags": [
@@ -1037,17 +1785,85 @@
1037
1785
  }
1038
1786
  },
1039
1787
  "responses": {
1040
- "200": {
1041
- "description": "The request resulted in a conflicting operation, see the content for more details.",
1788
+ "204": {
1789
+ "description": "The rest request ended in success with no data."
1790
+ },
1791
+ "400": {
1792
+ "description": "The server cannot process the request, see the content for more details.",
1042
1793
  "content": {
1043
- "text/plain": {
1794
+ "application/json": {
1044
1795
  "schema": {
1045
- "$ref": "#/components/schemas/NoContentResponse"
1796
+ "$ref": "#/components/schemas/Error"
1797
+ },
1798
+ "examples": {
1799
+ "exampleResponse": {
1800
+ "value": {
1801
+ "name": "GeneralError",
1802
+ "message": "errorMessage",
1803
+ "properties": {
1804
+ "foo": "bar"
1805
+ }
1806
+ }
1807
+ }
1046
1808
  }
1047
- },
1809
+ }
1810
+ }
1811
+ },
1812
+ "401": {
1813
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
1814
+ "content": {
1815
+ "application/json": {
1816
+ "schema": {
1817
+ "$ref": "#/components/schemas/Error"
1818
+ },
1819
+ "examples": {
1820
+ "exampleResponse": {
1821
+ "value": {
1822
+ "name": "UnauthorizedError",
1823
+ "message": "errorMessage"
1824
+ }
1825
+ }
1826
+ }
1827
+ }
1828
+ }
1829
+ },
1830
+ "409": {
1831
+ "description": "The request resulted in a conflicting operation, see the content for more details.",
1832
+ "content": {
1048
1833
  "application/json": {
1049
1834
  "schema": {
1050
1835
  "$ref": "#/components/schemas/ConflictResponse"
1836
+ },
1837
+ "examples": {
1838
+ "exampleResponse": {
1839
+ "value": {
1840
+ "name": "ConflictError",
1841
+ "message": "errorMessage",
1842
+ "properties": {
1843
+ "conflicts": [
1844
+ "1"
1845
+ ]
1846
+ }
1847
+ }
1848
+ }
1849
+ }
1850
+ }
1851
+ }
1852
+ },
1853
+ "500": {
1854
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
1855
+ "content": {
1856
+ "application/json": {
1857
+ "schema": {
1858
+ "$ref": "#/components/schemas/Error"
1859
+ },
1860
+ "examples": {
1861
+ "exampleResponse": {
1862
+ "value": {
1863
+ "name": "InternalServerError",
1864
+ "message": "errorMessage"
1865
+ }
1866
+ }
1051
1867
  }
1052
1868
  }
1053
1869
  }
@@ -1088,11 +1904,102 @@
1088
1904
  ],
1089
1905
  "responses": {
1090
1906
  "200": {
1907
+ "description": "Response to get an identity details.",
1908
+ "content": {
1909
+ "application/json": {
1910
+ "schema": {
1911
+ "$ref": "#/components/schemas/IdentityProfileGetResponse"
1912
+ },
1913
+ "examples": {
1914
+ "identityGetResponseExample": {
1915
+ "value": {
1916
+ "identity": "did:iota:tst:0xc57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
1917
+ "publicProfile": {
1918
+ "@context": "https://schema.org",
1919
+ "@type": "Person",
1920
+ "jobTitle": "Professor",
1921
+ "name": "Jane Doe"
1922
+ }
1923
+ }
1924
+ }
1925
+ }
1926
+ }
1927
+ }
1928
+ },
1929
+ "400": {
1930
+ "description": "The server cannot process the request, see the content for more details.",
1931
+ "content": {
1932
+ "application/json": {
1933
+ "schema": {
1934
+ "$ref": "#/components/schemas/Error"
1935
+ },
1936
+ "examples": {
1937
+ "exampleResponse": {
1938
+ "value": {
1939
+ "name": "GeneralError",
1940
+ "message": "errorMessage",
1941
+ "properties": {
1942
+ "foo": "bar"
1943
+ }
1944
+ }
1945
+ }
1946
+ }
1947
+ }
1948
+ }
1949
+ },
1950
+ "401": {
1951
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
1952
+ "content": {
1953
+ "application/json": {
1954
+ "schema": {
1955
+ "$ref": "#/components/schemas/Error"
1956
+ },
1957
+ "examples": {
1958
+ "exampleResponse": {
1959
+ "value": {
1960
+ "name": "UnauthorizedError",
1961
+ "message": "errorMessage"
1962
+ }
1963
+ }
1964
+ }
1965
+ }
1966
+ }
1967
+ },
1968
+ "404": {
1091
1969
  "description": "The resource you tried to access does not exist, see the content for more details.",
1092
1970
  "content": {
1093
1971
  "application/json": {
1094
1972
  "schema": {
1095
1973
  "$ref": "#/components/schemas/NotFoundResponse"
1974
+ },
1975
+ "examples": {
1976
+ "exampleResponse": {
1977
+ "value": {
1978
+ "name": "NotFoundError",
1979
+ "message": "errorMessage",
1980
+ "properties": {
1981
+ "notFoundId": "1"
1982
+ }
1983
+ }
1984
+ }
1985
+ }
1986
+ }
1987
+ }
1988
+ },
1989
+ "500": {
1990
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
1991
+ "content": {
1992
+ "application/json": {
1993
+ "schema": {
1994
+ "$ref": "#/components/schemas/Error"
1995
+ },
1996
+ "examples": {
1997
+ "exampleResponse": {
1998
+ "value": {
1999
+ "name": "InternalServerError",
2000
+ "message": "errorMessage"
2001
+ }
2002
+ }
1096
2003
  }
1097
2004
  }
1098
2005
  }
@@ -1140,17 +2047,83 @@
1140
2047
  }
1141
2048
  },
1142
2049
  "responses": {
1143
- "200": {
1144
- "description": "The resource you tried to access does not exist, see the content for more details.",
2050
+ "204": {
2051
+ "description": "The rest request ended in success with no data."
2052
+ },
2053
+ "400": {
2054
+ "description": "The server cannot process the request, see the content for more details.",
1145
2055
  "content": {
1146
- "text/plain": {
2056
+ "application/json": {
1147
2057
  "schema": {
1148
- "$ref": "#/components/schemas/NoContentResponse"
2058
+ "$ref": "#/components/schemas/Error"
2059
+ },
2060
+ "examples": {
2061
+ "exampleResponse": {
2062
+ "value": {
2063
+ "name": "GeneralError",
2064
+ "message": "errorMessage",
2065
+ "properties": {
2066
+ "foo": "bar"
2067
+ }
2068
+ }
2069
+ }
1149
2070
  }
1150
- },
2071
+ }
2072
+ }
2073
+ },
2074
+ "401": {
2075
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
2076
+ "content": {
2077
+ "application/json": {
2078
+ "schema": {
2079
+ "$ref": "#/components/schemas/Error"
2080
+ },
2081
+ "examples": {
2082
+ "exampleResponse": {
2083
+ "value": {
2084
+ "name": "UnauthorizedError",
2085
+ "message": "errorMessage"
2086
+ }
2087
+ }
2088
+ }
2089
+ }
2090
+ }
2091
+ },
2092
+ "404": {
2093
+ "description": "The resource you tried to access does not exist, see the content for more details.",
2094
+ "content": {
1151
2095
  "application/json": {
1152
2096
  "schema": {
1153
2097
  "$ref": "#/components/schemas/NotFoundResponse"
2098
+ },
2099
+ "examples": {
2100
+ "exampleResponse": {
2101
+ "value": {
2102
+ "name": "NotFoundError",
2103
+ "message": "errorMessage",
2104
+ "properties": {
2105
+ "notFoundId": "1"
2106
+ }
2107
+ }
2108
+ }
2109
+ }
2110
+ }
2111
+ }
2112
+ },
2113
+ "500": {
2114
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
2115
+ "content": {
2116
+ "application/json": {
2117
+ "schema": {
2118
+ "$ref": "#/components/schemas/Error"
2119
+ },
2120
+ "examples": {
2121
+ "exampleResponse": {
2122
+ "value": {
2123
+ "name": "InternalServerError",
2124
+ "message": "errorMessage"
2125
+ }
2126
+ }
1154
2127
  }
1155
2128
  }
1156
2129
  }
@@ -1169,17 +2142,83 @@
1169
2142
  }
1170
2143
  ],
1171
2144
  "responses": {
1172
- "200": {
1173
- "description": "The resource you tried to access does not exist, see the content for more details.",
2145
+ "204": {
2146
+ "description": "The rest request ended in success with no data."
2147
+ },
2148
+ "400": {
2149
+ "description": "The server cannot process the request, see the content for more details.",
1174
2150
  "content": {
1175
- "text/plain": {
2151
+ "application/json": {
1176
2152
  "schema": {
1177
- "$ref": "#/components/schemas/NoContentResponse"
2153
+ "$ref": "#/components/schemas/Error"
2154
+ },
2155
+ "examples": {
2156
+ "exampleResponse": {
2157
+ "value": {
2158
+ "name": "GeneralError",
2159
+ "message": "errorMessage",
2160
+ "properties": {
2161
+ "foo": "bar"
2162
+ }
2163
+ }
2164
+ }
1178
2165
  }
1179
- },
2166
+ }
2167
+ }
2168
+ },
2169
+ "401": {
2170
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
2171
+ "content": {
2172
+ "application/json": {
2173
+ "schema": {
2174
+ "$ref": "#/components/schemas/Error"
2175
+ },
2176
+ "examples": {
2177
+ "exampleResponse": {
2178
+ "value": {
2179
+ "name": "UnauthorizedError",
2180
+ "message": "errorMessage"
2181
+ }
2182
+ }
2183
+ }
2184
+ }
2185
+ }
2186
+ },
2187
+ "404": {
2188
+ "description": "The resource you tried to access does not exist, see the content for more details.",
2189
+ "content": {
1180
2190
  "application/json": {
1181
2191
  "schema": {
1182
2192
  "$ref": "#/components/schemas/NotFoundResponse"
2193
+ },
2194
+ "examples": {
2195
+ "exampleResponse": {
2196
+ "value": {
2197
+ "name": "NotFoundError",
2198
+ "message": "errorMessage",
2199
+ "properties": {
2200
+ "notFoundId": "1"
2201
+ }
2202
+ }
2203
+ }
2204
+ }
2205
+ }
2206
+ }
2207
+ },
2208
+ "500": {
2209
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
2210
+ "content": {
2211
+ "application/json": {
2212
+ "schema": {
2213
+ "$ref": "#/components/schemas/Error"
2214
+ },
2215
+ "examples": {
2216
+ "exampleResponse": {
2217
+ "value": {
2218
+ "name": "InternalServerError",
2219
+ "message": "errorMessage"
2220
+ }
2221
+ }
1183
2222
  }
1184
2223
  }
1185
2224
  }
@@ -1219,7 +2258,7 @@
1219
2258
  ],
1220
2259
  "responses": {
1221
2260
  "200": {
1222
- "description": "The resource you tried to access does not exist, see the content for more details.",
2261
+ "description": "Response to get an identity public profile.",
1223
2262
  "content": {
1224
2263
  "application/ld+json": {
1225
2264
  "schema": {
@@ -1235,10 +2274,73 @@
1235
2274
  }
1236
2275
  }
1237
2276
  }
1238
- },
2277
+ }
2278
+ },
2279
+ "headers": {
2280
+ "content-type": {
2281
+ "schema": {
2282
+ "type": "string"
2283
+ },
2284
+ "description": "e.g. application/ld+json"
2285
+ }
2286
+ }
2287
+ },
2288
+ "400": {
2289
+ "description": "The server cannot process the request, see the content for more details.",
2290
+ "content": {
2291
+ "application/json": {
2292
+ "schema": {
2293
+ "$ref": "#/components/schemas/Error"
2294
+ },
2295
+ "examples": {
2296
+ "exampleResponse": {
2297
+ "value": {
2298
+ "name": "GeneralError",
2299
+ "message": "errorMessage",
2300
+ "properties": {
2301
+ "foo": "bar"
2302
+ }
2303
+ }
2304
+ }
2305
+ }
2306
+ }
2307
+ }
2308
+ },
2309
+ "404": {
2310
+ "description": "The resource you tried to access does not exist, see the content for more details.",
2311
+ "content": {
1239
2312
  "application/json": {
1240
2313
  "schema": {
1241
2314
  "$ref": "#/components/schemas/NotFoundResponse"
2315
+ },
2316
+ "examples": {
2317
+ "exampleResponse": {
2318
+ "value": {
2319
+ "name": "NotFoundError",
2320
+ "message": "errorMessage",
2321
+ "properties": {
2322
+ "notFoundId": "1"
2323
+ }
2324
+ }
2325
+ }
2326
+ }
2327
+ }
2328
+ }
2329
+ },
2330
+ "500": {
2331
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
2332
+ "content": {
2333
+ "application/json": {
2334
+ "schema": {
2335
+ "$ref": "#/components/schemas/Error"
2336
+ },
2337
+ "examples": {
2338
+ "exampleResponse": {
2339
+ "value": {
2340
+ "name": "InternalServerError",
2341
+ "message": "errorMessage"
2342
+ }
2343
+ }
1242
2344
  }
1243
2345
  }
1244
2346
  }
@@ -1324,6 +2426,63 @@
1324
2426
  }
1325
2427
  }
1326
2428
  }
2429
+ },
2430
+ "400": {
2431
+ "description": "The server cannot process the request, see the content for more details.",
2432
+ "content": {
2433
+ "application/json": {
2434
+ "schema": {
2435
+ "$ref": "#/components/schemas/Error"
2436
+ },
2437
+ "examples": {
2438
+ "exampleResponse": {
2439
+ "value": {
2440
+ "name": "GeneralError",
2441
+ "message": "errorMessage",
2442
+ "properties": {
2443
+ "foo": "bar"
2444
+ }
2445
+ }
2446
+ }
2447
+ }
2448
+ }
2449
+ }
2450
+ },
2451
+ "401": {
2452
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
2453
+ "content": {
2454
+ "application/json": {
2455
+ "schema": {
2456
+ "$ref": "#/components/schemas/Error"
2457
+ },
2458
+ "examples": {
2459
+ "exampleResponse": {
2460
+ "value": {
2461
+ "name": "UnauthorizedError",
2462
+ "message": "errorMessage"
2463
+ }
2464
+ }
2465
+ }
2466
+ }
2467
+ }
2468
+ },
2469
+ "500": {
2470
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
2471
+ "content": {
2472
+ "application/json": {
2473
+ "schema": {
2474
+ "$ref": "#/components/schemas/Error"
2475
+ },
2476
+ "examples": {
2477
+ "exampleResponse": {
2478
+ "value": {
2479
+ "name": "InternalServerError",
2480
+ "message": "errorMessage"
2481
+ }
2482
+ }
2483
+ }
2484
+ }
2485
+ }
1327
2486
  }
1328
2487
  }
1329
2488
  }