@twin.org/identity-service 0.0.3-next.9 → 0.9.0
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.
- package/README.md +2 -2
- package/dist/es/identityProfileRoutes.js +1 -2
- package/dist/es/identityProfileRoutes.js.map +1 -1
- package/dist/es/identityProfileService.js +3 -3
- package/dist/es/identityProfileService.js.map +1 -1
- package/dist/es/identityResolverRoutes.js +3 -4
- package/dist/es/identityResolverRoutes.js.map +1 -1
- package/dist/es/identityResolverService.js +3 -0
- package/dist/es/identityResolverService.js.map +1 -1
- package/dist/es/identityRoutes.js +284 -14
- package/dist/es/identityRoutes.js.map +1 -1
- package/dist/es/identityService.js +154 -31
- package/dist/es/identityService.js.map +1 -1
- package/dist/es/models/IIdentityResolverServiceConfig.js.map +1 -1
- package/dist/es/models/IIdentityServiceConfig.js.map +1 -1
- package/dist/es/models/IIdentityServiceConstructorOptions.js.map +1 -1
- package/dist/es/restEntryPoints.js +3 -0
- package/dist/es/restEntryPoints.js.map +1 -1
- package/dist/types/identityProfileService.d.ts +3 -3
- package/dist/types/identityResolverRoutes.d.ts +1 -1
- package/dist/types/identityResolverService.d.ts +1 -0
- package/dist/types/identityRoutes.d.ts +33 -1
- package/dist/types/identityService.d.ts +59 -12
- package/dist/types/models/IIdentityResolverServiceConfig.d.ts +1 -1
- package/dist/types/models/IIdentityServiceConfig.d.ts +1 -1
- package/dist/types/models/IIdentityServiceConstructorOptions.d.ts +4 -0
- package/dist/types/restEntryPoints.d.ts +3 -0
- package/docs/changelog.md +682 -101
- package/docs/examples.md +196 -1
- package/docs/open-api/spec.json +804 -482
- package/docs/reference/classes/IdentityProfileService.md +11 -11
- package/docs/reference/classes/IdentityResolverService.md +7 -3
- package/docs/reference/classes/IdentityService.md +188 -44
- package/docs/reference/functions/generateRestRoutesIdentityResolver.md +1 -1
- package/docs/reference/functions/identityAlsoKnownAsCreate.md +31 -0
- package/docs/reference/functions/identityAlsoKnownAsRemove.md +31 -0
- package/docs/reference/functions/identityVerifiableCredentialVerifyDocument.md +31 -0
- package/docs/reference/functions/identityVerifiablePresentationVerifyDocument.md +31 -0
- package/docs/reference/index.md +4 -0
- package/docs/reference/interfaces/IIdentityProfileServiceConstructorOptions.md +2 -2
- package/docs/reference/interfaces/IIdentityResolverServiceConfig.md +3 -3
- package/docs/reference/interfaces/IIdentityResolverServiceConstructorOptions.md +4 -4
- package/docs/reference/interfaces/IIdentityServiceConfig.md +3 -3
- package/docs/reference/interfaces/IIdentityServiceConstructorOptions.md +10 -2
- package/docs/reference/variables/restEntryPoints.md +2 -0
- package/locales/en.json +2 -0
- package/package.json +17 -16
package/docs/open-api/spec.json
CHANGED
|
@@ -45,6 +45,11 @@
|
|
|
45
45
|
"example": "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a"
|
|
46
46
|
}
|
|
47
47
|
],
|
|
48
|
+
"security": [
|
|
49
|
+
{
|
|
50
|
+
"jwtBearerAuthScheme": []
|
|
51
|
+
}
|
|
52
|
+
],
|
|
48
53
|
"responses": {
|
|
49
54
|
"200": {
|
|
50
55
|
"description": "Response to resolving an identity.",
|
|
@@ -92,6 +97,24 @@
|
|
|
92
97
|
}
|
|
93
98
|
}
|
|
94
99
|
},
|
|
100
|
+
"401": {
|
|
101
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
102
|
+
"content": {
|
|
103
|
+
"application/json": {
|
|
104
|
+
"schema": {
|
|
105
|
+
"$ref": "#/components/schemas/Error"
|
|
106
|
+
},
|
|
107
|
+
"examples": {
|
|
108
|
+
"exampleResponse": {
|
|
109
|
+
"value": {
|
|
110
|
+
"name": "UnauthorizedError",
|
|
111
|
+
"message": "errorMessage"
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
},
|
|
95
118
|
"500": {
|
|
96
119
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
97
120
|
"content": {
|
|
@@ -765,35 +788,24 @@
|
|
|
765
788
|
}
|
|
766
789
|
}
|
|
767
790
|
},
|
|
768
|
-
"/identity/{identity}/
|
|
791
|
+
"/identity/{identity}/alias": {
|
|
769
792
|
"post": {
|
|
770
|
-
"operationId": "
|
|
771
|
-
"summary": "
|
|
793
|
+
"operationId": "identityAlsoKnownAsCreate",
|
|
794
|
+
"summary": "Add an alias to the alsoKnownAs property on the document",
|
|
772
795
|
"tags": [
|
|
773
796
|
"Identity"
|
|
774
797
|
],
|
|
775
798
|
"parameters": [
|
|
776
799
|
{
|
|
777
800
|
"name": "identity",
|
|
778
|
-
"description": "The identity to create the
|
|
779
|
-
"in": "path",
|
|
780
|
-
"required": true,
|
|
781
|
-
"schema": {
|
|
782
|
-
"type": "string"
|
|
783
|
-
},
|
|
784
|
-
"style": "simple",
|
|
785
|
-
"example": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a"
|
|
786
|
-
},
|
|
787
|
-
{
|
|
788
|
-
"name": "verificationMethodId",
|
|
789
|
-
"description": "The verification method id to use.",
|
|
801
|
+
"description": "The identity to create the alias for.",
|
|
790
802
|
"in": "path",
|
|
791
803
|
"required": true,
|
|
792
804
|
"schema": {
|
|
793
805
|
"type": "string"
|
|
794
806
|
},
|
|
795
807
|
"style": "simple",
|
|
796
|
-
"example": "
|
|
808
|
+
"example": "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a"
|
|
797
809
|
}
|
|
798
810
|
],
|
|
799
811
|
"security": [
|
|
@@ -802,24 +814,17 @@
|
|
|
802
814
|
}
|
|
803
815
|
],
|
|
804
816
|
"requestBody": {
|
|
805
|
-
"description": "Request to create
|
|
817
|
+
"description": "Request to create an alias for an identity.",
|
|
806
818
|
"required": true,
|
|
807
819
|
"content": {
|
|
808
820
|
"application/json": {
|
|
809
821
|
"schema": {
|
|
810
|
-
"$ref": "#/components/schemas/
|
|
822
|
+
"$ref": "#/components/schemas/IdentityAlsoKnownAsCreateRequest"
|
|
811
823
|
},
|
|
812
824
|
"examples": {
|
|
813
|
-
"
|
|
825
|
+
"identityAlsoKnownAsCreateRequestExample": {
|
|
814
826
|
"value": {
|
|
815
|
-
"
|
|
816
|
-
"subject": {
|
|
817
|
-
"@context": "https://schema.org",
|
|
818
|
-
"@type": "Person",
|
|
819
|
-
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
820
|
-
"name": "Jane Doe"
|
|
821
|
-
},
|
|
822
|
-
"revocationIndex": 5
|
|
827
|
+
"alias": "did:example:123"
|
|
823
828
|
}
|
|
824
829
|
}
|
|
825
830
|
}
|
|
@@ -827,44 +832,8 @@
|
|
|
827
832
|
}
|
|
828
833
|
},
|
|
829
834
|
"responses": {
|
|
830
|
-
"
|
|
831
|
-
"description": "
|
|
832
|
-
"content": {
|
|
833
|
-
"application/json": {
|
|
834
|
-
"schema": {
|
|
835
|
-
"$ref": "#/components/schemas/IdentityVerifiableCredentialCreateResponse"
|
|
836
|
-
},
|
|
837
|
-
"examples": {
|
|
838
|
-
"identityVerifiableCredentialCreateResponseExample": {
|
|
839
|
-
"value": {
|
|
840
|
-
"verifiableCredential": {
|
|
841
|
-
"@context": [
|
|
842
|
-
"https://www.w3.org/2018/credentials/v1",
|
|
843
|
-
"https://schema.org"
|
|
844
|
-
],
|
|
845
|
-
"id": "https://example.com/credentials/3732",
|
|
846
|
-
"type": [
|
|
847
|
-
"VerifiableCredential",
|
|
848
|
-
"Person"
|
|
849
|
-
],
|
|
850
|
-
"credentialSubject": {
|
|
851
|
-
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
852
|
-
"name": "Jane Doe"
|
|
853
|
-
},
|
|
854
|
-
"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
|
|
855
|
-
"issuanceDate": "2025-01-24T09:21:51.500Z",
|
|
856
|
-
"credentialStatus": {
|
|
857
|
-
"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
|
|
858
|
-
"type": "BitstringStatusList",
|
|
859
|
-
"revocationBitmapIndex": "5"
|
|
860
|
-
}
|
|
861
|
-
},
|
|
862
|
-
"jwt": "eyJraWQiOi...D1Z3AQ"
|
|
863
|
-
}
|
|
864
|
-
}
|
|
865
|
-
}
|
|
866
|
-
}
|
|
867
|
-
}
|
|
835
|
+
"204": {
|
|
836
|
+
"description": "The rest request ended in success with no data."
|
|
868
837
|
},
|
|
869
838
|
"400": {
|
|
870
839
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -926,58 +895,60 @@
|
|
|
926
895
|
}
|
|
927
896
|
}
|
|
928
897
|
},
|
|
929
|
-
"/identity/
|
|
930
|
-
"
|
|
931
|
-
"operationId": "
|
|
932
|
-
"summary": "
|
|
898
|
+
"/identity/{identity}/alias/{alias}": {
|
|
899
|
+
"delete": {
|
|
900
|
+
"operationId": "identityAlsoKnownAsRemove",
|
|
901
|
+
"summary": "Remove an alias from the alsoKnownAs property on the document",
|
|
933
902
|
"tags": [
|
|
934
903
|
"Identity"
|
|
935
904
|
],
|
|
936
905
|
"parameters": [
|
|
937
906
|
{
|
|
938
|
-
"name": "
|
|
939
|
-
"description": "The
|
|
940
|
-
"in": "
|
|
941
|
-
"required":
|
|
907
|
+
"name": "identity",
|
|
908
|
+
"description": "The identity to remove the alias from.",
|
|
909
|
+
"in": "path",
|
|
910
|
+
"required": true,
|
|
942
911
|
"schema": {
|
|
943
912
|
"type": "string"
|
|
944
913
|
},
|
|
945
|
-
"
|
|
914
|
+
"style": "simple",
|
|
915
|
+
"example": "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a"
|
|
916
|
+
},
|
|
917
|
+
{
|
|
918
|
+
"name": "alias",
|
|
919
|
+
"description": "The alias to remove.",
|
|
920
|
+
"in": "path",
|
|
921
|
+
"required": true,
|
|
922
|
+
"schema": {
|
|
923
|
+
"type": "string"
|
|
924
|
+
},
|
|
925
|
+
"style": "simple",
|
|
926
|
+
"example": "did:example:123"
|
|
927
|
+
}
|
|
928
|
+
],
|
|
929
|
+
"security": [
|
|
930
|
+
{
|
|
931
|
+
"jwtBearerAuthScheme": []
|
|
946
932
|
}
|
|
947
933
|
],
|
|
948
934
|
"responses": {
|
|
949
|
-
"
|
|
950
|
-
"description": "
|
|
935
|
+
"204": {
|
|
936
|
+
"description": "The rest request ended in success with no data."
|
|
937
|
+
},
|
|
938
|
+
"400": {
|
|
939
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
951
940
|
"content": {
|
|
952
941
|
"application/json": {
|
|
953
942
|
"schema": {
|
|
954
|
-
"$ref": "#/components/schemas/
|
|
943
|
+
"$ref": "#/components/schemas/Error"
|
|
955
944
|
},
|
|
956
945
|
"examples": {
|
|
957
|
-
"
|
|
946
|
+
"exampleResponse": {
|
|
958
947
|
"value": {
|
|
959
|
-
"
|
|
960
|
-
"
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
"https://schema.org"
|
|
964
|
-
],
|
|
965
|
-
"id": "https://example.com/credentials/3732",
|
|
966
|
-
"type": [
|
|
967
|
-
"VerifiableCredential",
|
|
968
|
-
"Person"
|
|
969
|
-
],
|
|
970
|
-
"credentialSubject": {
|
|
971
|
-
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
972
|
-
"name": "Jane Doe"
|
|
973
|
-
},
|
|
974
|
-
"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
|
|
975
|
-
"issuanceDate": "2025-01-24T09:21:51.500Z",
|
|
976
|
-
"credentialStatus": {
|
|
977
|
-
"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
|
|
978
|
-
"type": "BitstringStatusList",
|
|
979
|
-
"revocationBitmapIndex": "5"
|
|
980
|
-
}
|
|
948
|
+
"name": "GeneralError",
|
|
949
|
+
"message": "errorMessage",
|
|
950
|
+
"properties": {
|
|
951
|
+
"foo": "bar"
|
|
981
952
|
}
|
|
982
953
|
}
|
|
983
954
|
}
|
|
@@ -985,8 +956,8 @@
|
|
|
985
956
|
}
|
|
986
957
|
}
|
|
987
958
|
},
|
|
988
|
-
"
|
|
989
|
-
"description": "
|
|
959
|
+
"401": {
|
|
960
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
990
961
|
"content": {
|
|
991
962
|
"application/json": {
|
|
992
963
|
"schema": {
|
|
@@ -995,11 +966,8 @@
|
|
|
995
966
|
"examples": {
|
|
996
967
|
"exampleResponse": {
|
|
997
968
|
"value": {
|
|
998
|
-
"name": "
|
|
999
|
-
"message": "errorMessage"
|
|
1000
|
-
"properties": {
|
|
1001
|
-
"foo": "bar"
|
|
1002
|
-
}
|
|
969
|
+
"name": "UnauthorizedError",
|
|
970
|
+
"message": "errorMessage"
|
|
1003
971
|
}
|
|
1004
972
|
}
|
|
1005
973
|
}
|
|
@@ -1027,17 +995,17 @@
|
|
|
1027
995
|
}
|
|
1028
996
|
}
|
|
1029
997
|
},
|
|
1030
|
-
"/identity/{identity}/verifiable-credential/
|
|
1031
|
-
"
|
|
1032
|
-
"operationId": "
|
|
1033
|
-
"summary": "
|
|
998
|
+
"/identity/{identity}/verifiable-credential/{verificationMethodId}": {
|
|
999
|
+
"post": {
|
|
1000
|
+
"operationId": "identityVerifiableCredentialCreate",
|
|
1001
|
+
"summary": "Create an identity verifiable credential",
|
|
1034
1002
|
"tags": [
|
|
1035
1003
|
"Identity"
|
|
1036
1004
|
],
|
|
1037
1005
|
"parameters": [
|
|
1038
1006
|
{
|
|
1039
1007
|
"name": "identity",
|
|
1040
|
-
"description": "The identity to
|
|
1008
|
+
"description": "The identity to create the verification credential for.",
|
|
1041
1009
|
"in": "path",
|
|
1042
1010
|
"required": true,
|
|
1043
1011
|
"schema": {
|
|
@@ -1047,15 +1015,15 @@
|
|
|
1047
1015
|
"example": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a"
|
|
1048
1016
|
},
|
|
1049
1017
|
{
|
|
1050
|
-
"name": "
|
|
1051
|
-
"description": "The
|
|
1018
|
+
"name": "verificationMethodId",
|
|
1019
|
+
"description": "The verification method id to use.",
|
|
1052
1020
|
"in": "path",
|
|
1053
1021
|
"required": true,
|
|
1054
1022
|
"schema": {
|
|
1055
1023
|
"type": "string"
|
|
1056
1024
|
},
|
|
1057
1025
|
"style": "simple",
|
|
1058
|
-
"example": "
|
|
1026
|
+
"example": "my-assertion"
|
|
1059
1027
|
}
|
|
1060
1028
|
],
|
|
1061
1029
|
"security": [
|
|
@@ -1063,9 +1031,70 @@
|
|
|
1063
1031
|
"jwtBearerAuthScheme": []
|
|
1064
1032
|
}
|
|
1065
1033
|
],
|
|
1034
|
+
"requestBody": {
|
|
1035
|
+
"description": "Request to create a verifiable credential.",
|
|
1036
|
+
"required": true,
|
|
1037
|
+
"content": {
|
|
1038
|
+
"application/json": {
|
|
1039
|
+
"schema": {
|
|
1040
|
+
"$ref": "#/components/schemas/IdentityVerifiableCredentialCreateRequest"
|
|
1041
|
+
},
|
|
1042
|
+
"examples": {
|
|
1043
|
+
"identityVerifiableCredentialCreateRequestExample": {
|
|
1044
|
+
"value": {
|
|
1045
|
+
"credentialId": "https://example.com/credentials/3732",
|
|
1046
|
+
"subject": {
|
|
1047
|
+
"@context": "https://schema.org",
|
|
1048
|
+
"@type": "Person",
|
|
1049
|
+
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
1050
|
+
"name": "Jane Doe"
|
|
1051
|
+
},
|
|
1052
|
+
"revocationIndex": 5
|
|
1053
|
+
}
|
|
1054
|
+
}
|
|
1055
|
+
}
|
|
1056
|
+
}
|
|
1057
|
+
}
|
|
1058
|
+
},
|
|
1066
1059
|
"responses": {
|
|
1067
|
-
"
|
|
1068
|
-
"description": "
|
|
1060
|
+
"200": {
|
|
1061
|
+
"description": "Response to creating a verifiable credential.",
|
|
1062
|
+
"content": {
|
|
1063
|
+
"application/json": {
|
|
1064
|
+
"schema": {
|
|
1065
|
+
"$ref": "#/components/schemas/IdentityVerifiableCredentialCreateResponse"
|
|
1066
|
+
},
|
|
1067
|
+
"examples": {
|
|
1068
|
+
"identityVerifiableCredentialCreateResponseExample": {
|
|
1069
|
+
"value": {
|
|
1070
|
+
"verifiableCredential": {
|
|
1071
|
+
"@context": [
|
|
1072
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
1073
|
+
"https://schema.org"
|
|
1074
|
+
],
|
|
1075
|
+
"id": "https://example.com/credentials/3732",
|
|
1076
|
+
"type": [
|
|
1077
|
+
"VerifiableCredential",
|
|
1078
|
+
"Person"
|
|
1079
|
+
],
|
|
1080
|
+
"credentialSubject": {
|
|
1081
|
+
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
1082
|
+
"name": "Jane Doe"
|
|
1083
|
+
},
|
|
1084
|
+
"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
|
|
1085
|
+
"issuanceDate": "2025-01-24T09:21:51.500Z",
|
|
1086
|
+
"credentialStatus": {
|
|
1087
|
+
"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
|
|
1088
|
+
"type": "BitstringStatusList",
|
|
1089
|
+
"revocationBitmapIndex": "5"
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
"jwt": "eyJraWQiOi...D1Z3AQ"
|
|
1093
|
+
}
|
|
1094
|
+
}
|
|
1095
|
+
}
|
|
1096
|
+
}
|
|
1097
|
+
}
|
|
1069
1098
|
},
|
|
1070
1099
|
"400": {
|
|
1071
1100
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -1127,16 +1156,389 @@
|
|
|
1127
1156
|
}
|
|
1128
1157
|
}
|
|
1129
1158
|
},
|
|
1130
|
-
"/identity/
|
|
1131
|
-
"
|
|
1132
|
-
"operationId": "
|
|
1133
|
-
"summary": "
|
|
1159
|
+
"/identity/verifiable-credential/verify/document": {
|
|
1160
|
+
"post": {
|
|
1161
|
+
"operationId": "identityVerifiableCredentialVerifyDocument",
|
|
1162
|
+
"summary": "Verify an identity verifiable credential document",
|
|
1134
1163
|
"tags": [
|
|
1135
1164
|
"Identity"
|
|
1136
1165
|
],
|
|
1137
|
-
"
|
|
1166
|
+
"security": [
|
|
1138
1167
|
{
|
|
1139
|
-
"
|
|
1168
|
+
"jwtBearerAuthScheme": []
|
|
1169
|
+
}
|
|
1170
|
+
],
|
|
1171
|
+
"requestBody": {
|
|
1172
|
+
"description": "Request to verify a verifiable credential.",
|
|
1173
|
+
"required": true,
|
|
1174
|
+
"content": {
|
|
1175
|
+
"application/json": {
|
|
1176
|
+
"schema": {
|
|
1177
|
+
"$ref": "https://schema.twindev.org/w3c-did/DidVerifiableCredential"
|
|
1178
|
+
},
|
|
1179
|
+
"examples": {
|
|
1180
|
+
"identityVerifiableCredentialVerifyDocumentRequestExample": {
|
|
1181
|
+
"value": {
|
|
1182
|
+
"@context": [
|
|
1183
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
1184
|
+
"https://schema.org"
|
|
1185
|
+
],
|
|
1186
|
+
"id": "https://example.com/credentials/3732",
|
|
1187
|
+
"type": [
|
|
1188
|
+
"VerifiableCredential",
|
|
1189
|
+
"Person"
|
|
1190
|
+
],
|
|
1191
|
+
"credentialSubject": {
|
|
1192
|
+
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
1193
|
+
"name": "Jane Doe"
|
|
1194
|
+
},
|
|
1195
|
+
"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
|
|
1196
|
+
"issuanceDate": "2025-01-24T09:21:51.500Z",
|
|
1197
|
+
"credentialStatus": {
|
|
1198
|
+
"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
|
|
1199
|
+
"type": "BitstringStatusList",
|
|
1200
|
+
"revocationBitmapIndex": "5"
|
|
1201
|
+
}
|
|
1202
|
+
}
|
|
1203
|
+
}
|
|
1204
|
+
}
|
|
1205
|
+
}
|
|
1206
|
+
}
|
|
1207
|
+
},
|
|
1208
|
+
"responses": {
|
|
1209
|
+
"200": {
|
|
1210
|
+
"description": "Response to verifying a verifiable credential.",
|
|
1211
|
+
"content": {
|
|
1212
|
+
"application/json": {
|
|
1213
|
+
"schema": {
|
|
1214
|
+
"$ref": "#/components/schemas/IdentityVerifiableCredentialVerifyResponse"
|
|
1215
|
+
},
|
|
1216
|
+
"examples": {
|
|
1217
|
+
"identityVerifiableCredentialVerifyResponseExample": {
|
|
1218
|
+
"value": {
|
|
1219
|
+
"revoked": false,
|
|
1220
|
+
"verifiableCredential": {
|
|
1221
|
+
"@context": [
|
|
1222
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
1223
|
+
"https://schema.org"
|
|
1224
|
+
],
|
|
1225
|
+
"id": "https://example.com/credentials/3732",
|
|
1226
|
+
"type": [
|
|
1227
|
+
"VerifiableCredential",
|
|
1228
|
+
"Person"
|
|
1229
|
+
],
|
|
1230
|
+
"credentialSubject": {
|
|
1231
|
+
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
1232
|
+
"name": "Jane Doe"
|
|
1233
|
+
},
|
|
1234
|
+
"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
|
|
1235
|
+
"issuanceDate": "2025-01-24T09:21:51.500Z",
|
|
1236
|
+
"credentialStatus": {
|
|
1237
|
+
"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
|
|
1238
|
+
"type": "BitstringStatusList",
|
|
1239
|
+
"revocationBitmapIndex": "5"
|
|
1240
|
+
}
|
|
1241
|
+
}
|
|
1242
|
+
}
|
|
1243
|
+
}
|
|
1244
|
+
}
|
|
1245
|
+
}
|
|
1246
|
+
}
|
|
1247
|
+
},
|
|
1248
|
+
"400": {
|
|
1249
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
1250
|
+
"content": {
|
|
1251
|
+
"application/json": {
|
|
1252
|
+
"schema": {
|
|
1253
|
+
"$ref": "#/components/schemas/Error"
|
|
1254
|
+
},
|
|
1255
|
+
"examples": {
|
|
1256
|
+
"exampleResponse": {
|
|
1257
|
+
"value": {
|
|
1258
|
+
"name": "GeneralError",
|
|
1259
|
+
"message": "errorMessage",
|
|
1260
|
+
"properties": {
|
|
1261
|
+
"foo": "bar"
|
|
1262
|
+
}
|
|
1263
|
+
}
|
|
1264
|
+
}
|
|
1265
|
+
}
|
|
1266
|
+
}
|
|
1267
|
+
}
|
|
1268
|
+
},
|
|
1269
|
+
"401": {
|
|
1270
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
1271
|
+
"content": {
|
|
1272
|
+
"application/json": {
|
|
1273
|
+
"schema": {
|
|
1274
|
+
"$ref": "#/components/schemas/Error"
|
|
1275
|
+
},
|
|
1276
|
+
"examples": {
|
|
1277
|
+
"exampleResponse": {
|
|
1278
|
+
"value": {
|
|
1279
|
+
"name": "UnauthorizedError",
|
|
1280
|
+
"message": "errorMessage"
|
|
1281
|
+
}
|
|
1282
|
+
}
|
|
1283
|
+
}
|
|
1284
|
+
}
|
|
1285
|
+
}
|
|
1286
|
+
},
|
|
1287
|
+
"500": {
|
|
1288
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1289
|
+
"content": {
|
|
1290
|
+
"application/json": {
|
|
1291
|
+
"schema": {
|
|
1292
|
+
"$ref": "#/components/schemas/Error"
|
|
1293
|
+
},
|
|
1294
|
+
"examples": {
|
|
1295
|
+
"exampleResponse": {
|
|
1296
|
+
"value": {
|
|
1297
|
+
"name": "InternalServerError",
|
|
1298
|
+
"message": "errorMessage"
|
|
1299
|
+
}
|
|
1300
|
+
}
|
|
1301
|
+
}
|
|
1302
|
+
}
|
|
1303
|
+
}
|
|
1304
|
+
}
|
|
1305
|
+
}
|
|
1306
|
+
}
|
|
1307
|
+
},
|
|
1308
|
+
"/identity/verifiable-credential/verify": {
|
|
1309
|
+
"get": {
|
|
1310
|
+
"operationId": "identityVerifiableCredentialVerify",
|
|
1311
|
+
"summary": "Verify an identity verifiable credential",
|
|
1312
|
+
"tags": [
|
|
1313
|
+
"Identity"
|
|
1314
|
+
],
|
|
1315
|
+
"parameters": [
|
|
1316
|
+
{
|
|
1317
|
+
"name": "jwt",
|
|
1318
|
+
"description": "The jwt to verify.",
|
|
1319
|
+
"in": "query",
|
|
1320
|
+
"required": false,
|
|
1321
|
+
"schema": {
|
|
1322
|
+
"type": "string"
|
|
1323
|
+
},
|
|
1324
|
+
"example": "eyJraWQiOi...D1Z3AQ"
|
|
1325
|
+
}
|
|
1326
|
+
],
|
|
1327
|
+
"security": [
|
|
1328
|
+
{
|
|
1329
|
+
"jwtBearerAuthScheme": []
|
|
1330
|
+
}
|
|
1331
|
+
],
|
|
1332
|
+
"responses": {
|
|
1333
|
+
"200": {
|
|
1334
|
+
"description": "Response to verifying a verifiable credential.",
|
|
1335
|
+
"content": {
|
|
1336
|
+
"application/json": {
|
|
1337
|
+
"schema": {
|
|
1338
|
+
"$ref": "#/components/schemas/IdentityVerifiableCredentialVerifyResponse"
|
|
1339
|
+
},
|
|
1340
|
+
"examples": {
|
|
1341
|
+
"identityVerifiableCredentialVerifyResponseExample": {
|
|
1342
|
+
"value": {
|
|
1343
|
+
"revoked": false,
|
|
1344
|
+
"verifiableCredential": {
|
|
1345
|
+
"@context": [
|
|
1346
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
1347
|
+
"https://schema.org"
|
|
1348
|
+
],
|
|
1349
|
+
"id": "https://example.com/credentials/3732",
|
|
1350
|
+
"type": [
|
|
1351
|
+
"VerifiableCredential",
|
|
1352
|
+
"Person"
|
|
1353
|
+
],
|
|
1354
|
+
"credentialSubject": {
|
|
1355
|
+
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
1356
|
+
"name": "Jane Doe"
|
|
1357
|
+
},
|
|
1358
|
+
"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
|
|
1359
|
+
"issuanceDate": "2025-01-24T09:21:51.500Z",
|
|
1360
|
+
"credentialStatus": {
|
|
1361
|
+
"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
|
|
1362
|
+
"type": "BitstringStatusList",
|
|
1363
|
+
"revocationBitmapIndex": "5"
|
|
1364
|
+
}
|
|
1365
|
+
}
|
|
1366
|
+
}
|
|
1367
|
+
}
|
|
1368
|
+
}
|
|
1369
|
+
}
|
|
1370
|
+
}
|
|
1371
|
+
},
|
|
1372
|
+
"400": {
|
|
1373
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
1374
|
+
"content": {
|
|
1375
|
+
"application/json": {
|
|
1376
|
+
"schema": {
|
|
1377
|
+
"$ref": "#/components/schemas/Error"
|
|
1378
|
+
},
|
|
1379
|
+
"examples": {
|
|
1380
|
+
"exampleResponse": {
|
|
1381
|
+
"value": {
|
|
1382
|
+
"name": "GeneralError",
|
|
1383
|
+
"message": "errorMessage",
|
|
1384
|
+
"properties": {
|
|
1385
|
+
"foo": "bar"
|
|
1386
|
+
}
|
|
1387
|
+
}
|
|
1388
|
+
}
|
|
1389
|
+
}
|
|
1390
|
+
}
|
|
1391
|
+
}
|
|
1392
|
+
},
|
|
1393
|
+
"401": {
|
|
1394
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
1395
|
+
"content": {
|
|
1396
|
+
"application/json": {
|
|
1397
|
+
"schema": {
|
|
1398
|
+
"$ref": "#/components/schemas/Error"
|
|
1399
|
+
},
|
|
1400
|
+
"examples": {
|
|
1401
|
+
"exampleResponse": {
|
|
1402
|
+
"value": {
|
|
1403
|
+
"name": "UnauthorizedError",
|
|
1404
|
+
"message": "errorMessage"
|
|
1405
|
+
}
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
}
|
|
1409
|
+
}
|
|
1410
|
+
},
|
|
1411
|
+
"500": {
|
|
1412
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1413
|
+
"content": {
|
|
1414
|
+
"application/json": {
|
|
1415
|
+
"schema": {
|
|
1416
|
+
"$ref": "#/components/schemas/Error"
|
|
1417
|
+
},
|
|
1418
|
+
"examples": {
|
|
1419
|
+
"exampleResponse": {
|
|
1420
|
+
"value": {
|
|
1421
|
+
"name": "InternalServerError",
|
|
1422
|
+
"message": "errorMessage"
|
|
1423
|
+
}
|
|
1424
|
+
}
|
|
1425
|
+
}
|
|
1426
|
+
}
|
|
1427
|
+
}
|
|
1428
|
+
}
|
|
1429
|
+
}
|
|
1430
|
+
}
|
|
1431
|
+
},
|
|
1432
|
+
"/identity/{identity}/verifiable-credential/revoke/{revocationIndex}": {
|
|
1433
|
+
"get": {
|
|
1434
|
+
"operationId": "identityVerifiableCredentialRevoke",
|
|
1435
|
+
"summary": "Revoke an identity verifiable credential",
|
|
1436
|
+
"tags": [
|
|
1437
|
+
"Identity"
|
|
1438
|
+
],
|
|
1439
|
+
"parameters": [
|
|
1440
|
+
{
|
|
1441
|
+
"name": "identity",
|
|
1442
|
+
"description": "The identity to revoke the verification credential for.",
|
|
1443
|
+
"in": "path",
|
|
1444
|
+
"required": true,
|
|
1445
|
+
"schema": {
|
|
1446
|
+
"type": "string"
|
|
1447
|
+
},
|
|
1448
|
+
"style": "simple",
|
|
1449
|
+
"example": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a"
|
|
1450
|
+
},
|
|
1451
|
+
{
|
|
1452
|
+
"name": "revocationIndex",
|
|
1453
|
+
"description": "The revocation index to revoke.",
|
|
1454
|
+
"in": "path",
|
|
1455
|
+
"required": true,
|
|
1456
|
+
"schema": {
|
|
1457
|
+
"type": "string"
|
|
1458
|
+
},
|
|
1459
|
+
"style": "simple",
|
|
1460
|
+
"example": "5"
|
|
1461
|
+
}
|
|
1462
|
+
],
|
|
1463
|
+
"security": [
|
|
1464
|
+
{
|
|
1465
|
+
"jwtBearerAuthScheme": []
|
|
1466
|
+
}
|
|
1467
|
+
],
|
|
1468
|
+
"responses": {
|
|
1469
|
+
"204": {
|
|
1470
|
+
"description": "The rest request ended in success with no data."
|
|
1471
|
+
},
|
|
1472
|
+
"400": {
|
|
1473
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
1474
|
+
"content": {
|
|
1475
|
+
"application/json": {
|
|
1476
|
+
"schema": {
|
|
1477
|
+
"$ref": "#/components/schemas/Error"
|
|
1478
|
+
},
|
|
1479
|
+
"examples": {
|
|
1480
|
+
"exampleResponse": {
|
|
1481
|
+
"value": {
|
|
1482
|
+
"name": "GeneralError",
|
|
1483
|
+
"message": "errorMessage",
|
|
1484
|
+
"properties": {
|
|
1485
|
+
"foo": "bar"
|
|
1486
|
+
}
|
|
1487
|
+
}
|
|
1488
|
+
}
|
|
1489
|
+
}
|
|
1490
|
+
}
|
|
1491
|
+
}
|
|
1492
|
+
},
|
|
1493
|
+
"401": {
|
|
1494
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
1495
|
+
"content": {
|
|
1496
|
+
"application/json": {
|
|
1497
|
+
"schema": {
|
|
1498
|
+
"$ref": "#/components/schemas/Error"
|
|
1499
|
+
},
|
|
1500
|
+
"examples": {
|
|
1501
|
+
"exampleResponse": {
|
|
1502
|
+
"value": {
|
|
1503
|
+
"name": "UnauthorizedError",
|
|
1504
|
+
"message": "errorMessage"
|
|
1505
|
+
}
|
|
1506
|
+
}
|
|
1507
|
+
}
|
|
1508
|
+
}
|
|
1509
|
+
}
|
|
1510
|
+
},
|
|
1511
|
+
"500": {
|
|
1512
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1513
|
+
"content": {
|
|
1514
|
+
"application/json": {
|
|
1515
|
+
"schema": {
|
|
1516
|
+
"$ref": "#/components/schemas/Error"
|
|
1517
|
+
},
|
|
1518
|
+
"examples": {
|
|
1519
|
+
"exampleResponse": {
|
|
1520
|
+
"value": {
|
|
1521
|
+
"name": "InternalServerError",
|
|
1522
|
+
"message": "errorMessage"
|
|
1523
|
+
}
|
|
1524
|
+
}
|
|
1525
|
+
}
|
|
1526
|
+
}
|
|
1527
|
+
}
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
}
|
|
1531
|
+
},
|
|
1532
|
+
"/identity/{identity}/verifiable-credential/unrevoke/{revocationIndex}": {
|
|
1533
|
+
"get": {
|
|
1534
|
+
"operationId": "identityVerifiableCredentialUnrevoke",
|
|
1535
|
+
"summary": "Unrevoke an identity verifiable credential",
|
|
1536
|
+
"tags": [
|
|
1537
|
+
"Identity"
|
|
1538
|
+
],
|
|
1539
|
+
"parameters": [
|
|
1540
|
+
{
|
|
1541
|
+
"name": "identity",
|
|
1140
1542
|
"description": "The identity to unrevoke the verification credential for.",
|
|
1141
1543
|
"in": "path",
|
|
1142
1544
|
"required": true,
|
|
@@ -1377,6 +1779,161 @@
|
|
|
1377
1779
|
}
|
|
1378
1780
|
}
|
|
1379
1781
|
},
|
|
1782
|
+
"/identity/verifiable-presentation/verify/document": {
|
|
1783
|
+
"post": {
|
|
1784
|
+
"operationId": "identityVerifiablePresentationVerifyDocument",
|
|
1785
|
+
"summary": "Verify an identity verifiable presentation document",
|
|
1786
|
+
"tags": [
|
|
1787
|
+
"Identity"
|
|
1788
|
+
],
|
|
1789
|
+
"security": [
|
|
1790
|
+
{
|
|
1791
|
+
"jwtBearerAuthScheme": []
|
|
1792
|
+
}
|
|
1793
|
+
],
|
|
1794
|
+
"requestBody": {
|
|
1795
|
+
"description": "Request to verify a verifiable presentation.",
|
|
1796
|
+
"required": true,
|
|
1797
|
+
"content": {
|
|
1798
|
+
"application/json": {
|
|
1799
|
+
"schema": {
|
|
1800
|
+
"$ref": "https://schema.twindev.org/w3c-did/DidVerifiablePresentation"
|
|
1801
|
+
},
|
|
1802
|
+
"examples": {
|
|
1803
|
+
"identityVerifiablePresentationVerifyDocumentRequestExample": {
|
|
1804
|
+
"value": {
|
|
1805
|
+
"@context": [
|
|
1806
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
1807
|
+
"https://schema.org"
|
|
1808
|
+
],
|
|
1809
|
+
"id": "https://example.com/credentials/3732",
|
|
1810
|
+
"type": [
|
|
1811
|
+
"VerifiableCredential",
|
|
1812
|
+
"Person"
|
|
1813
|
+
],
|
|
1814
|
+
"verifiableCredential": [
|
|
1815
|
+
{
|
|
1816
|
+
"@context": [
|
|
1817
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
1818
|
+
"https://schema.org"
|
|
1819
|
+
],
|
|
1820
|
+
"id": "https://example.com/credentials/3732",
|
|
1821
|
+
"type": [
|
|
1822
|
+
"VerifiableCredential",
|
|
1823
|
+
"Person"
|
|
1824
|
+
],
|
|
1825
|
+
"credentialSubject": {
|
|
1826
|
+
"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
|
|
1827
|
+
"name": "Jane Doe"
|
|
1828
|
+
},
|
|
1829
|
+
"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
|
|
1830
|
+
"issuanceDate": "2025-01-24T09:21:51.500Z",
|
|
1831
|
+
"credentialStatus": {
|
|
1832
|
+
"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
|
|
1833
|
+
"type": "BitstringStatusList",
|
|
1834
|
+
"revocationBitmapIndex": "5"
|
|
1835
|
+
}
|
|
1836
|
+
}
|
|
1837
|
+
]
|
|
1838
|
+
}
|
|
1839
|
+
}
|
|
1840
|
+
}
|
|
1841
|
+
}
|
|
1842
|
+
}
|
|
1843
|
+
},
|
|
1844
|
+
"responses": {
|
|
1845
|
+
"200": {
|
|
1846
|
+
"description": "Response to verifying a verifiable presentation.",
|
|
1847
|
+
"content": {
|
|
1848
|
+
"application/json": {
|
|
1849
|
+
"schema": {
|
|
1850
|
+
"$ref": "#/components/schemas/IdentityVerifiablePresentationVerifyResponse"
|
|
1851
|
+
},
|
|
1852
|
+
"examples": {
|
|
1853
|
+
"identityVerifiablePresentationVerifyResponseExample": {
|
|
1854
|
+
"value": {
|
|
1855
|
+
"revoked": false,
|
|
1856
|
+
"verifiablePresentation": {
|
|
1857
|
+
"@context": [
|
|
1858
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
1859
|
+
"https://schema.org"
|
|
1860
|
+
],
|
|
1861
|
+
"id": "presentationId",
|
|
1862
|
+
"type": [
|
|
1863
|
+
"VerifiablePresentation",
|
|
1864
|
+
"Person"
|
|
1865
|
+
],
|
|
1866
|
+
"verifiableCredential": [
|
|
1867
|
+
"eyJraWQiOi...D1Z3AQ"
|
|
1868
|
+
],
|
|
1869
|
+
"holder": "did:entity-storage:0xcea318e06e89f3fb4048160770effd84d0cfa5801fee13dfa6f9413a00429cec"
|
|
1870
|
+
}
|
|
1871
|
+
}
|
|
1872
|
+
}
|
|
1873
|
+
}
|
|
1874
|
+
}
|
|
1875
|
+
}
|
|
1876
|
+
},
|
|
1877
|
+
"400": {
|
|
1878
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
1879
|
+
"content": {
|
|
1880
|
+
"application/json": {
|
|
1881
|
+
"schema": {
|
|
1882
|
+
"$ref": "#/components/schemas/Error"
|
|
1883
|
+
},
|
|
1884
|
+
"examples": {
|
|
1885
|
+
"exampleResponse": {
|
|
1886
|
+
"value": {
|
|
1887
|
+
"name": "GeneralError",
|
|
1888
|
+
"message": "errorMessage",
|
|
1889
|
+
"properties": {
|
|
1890
|
+
"foo": "bar"
|
|
1891
|
+
}
|
|
1892
|
+
}
|
|
1893
|
+
}
|
|
1894
|
+
}
|
|
1895
|
+
}
|
|
1896
|
+
}
|
|
1897
|
+
},
|
|
1898
|
+
"401": {
|
|
1899
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
1900
|
+
"content": {
|
|
1901
|
+
"application/json": {
|
|
1902
|
+
"schema": {
|
|
1903
|
+
"$ref": "#/components/schemas/Error"
|
|
1904
|
+
},
|
|
1905
|
+
"examples": {
|
|
1906
|
+
"exampleResponse": {
|
|
1907
|
+
"value": {
|
|
1908
|
+
"name": "UnauthorizedError",
|
|
1909
|
+
"message": "errorMessage"
|
|
1910
|
+
}
|
|
1911
|
+
}
|
|
1912
|
+
}
|
|
1913
|
+
}
|
|
1914
|
+
}
|
|
1915
|
+
},
|
|
1916
|
+
"500": {
|
|
1917
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1918
|
+
"content": {
|
|
1919
|
+
"application/json": {
|
|
1920
|
+
"schema": {
|
|
1921
|
+
"$ref": "#/components/schemas/Error"
|
|
1922
|
+
},
|
|
1923
|
+
"examples": {
|
|
1924
|
+
"exampleResponse": {
|
|
1925
|
+
"value": {
|
|
1926
|
+
"name": "InternalServerError",
|
|
1927
|
+
"message": "errorMessage"
|
|
1928
|
+
}
|
|
1929
|
+
}
|
|
1930
|
+
}
|
|
1931
|
+
}
|
|
1932
|
+
}
|
|
1933
|
+
}
|
|
1934
|
+
}
|
|
1935
|
+
}
|
|
1936
|
+
},
|
|
1380
1937
|
"/identity/verifiable-presentation/verify": {
|
|
1381
1938
|
"get": {
|
|
1382
1939
|
"operationId": "identityVerifiablePresentationVerify",
|
|
@@ -1396,6 +1953,11 @@
|
|
|
1396
1953
|
"example": "eyJraWQiOi...D1Z3AQ"
|
|
1397
1954
|
}
|
|
1398
1955
|
],
|
|
1956
|
+
"security": [
|
|
1957
|
+
{
|
|
1958
|
+
"jwtBearerAuthScheme": []
|
|
1959
|
+
}
|
|
1960
|
+
],
|
|
1399
1961
|
"responses": {
|
|
1400
1962
|
"200": {
|
|
1401
1963
|
"description": "Response to verifying a verifiable presentation.",
|
|
@@ -1450,6 +2012,24 @@
|
|
|
1450
2012
|
}
|
|
1451
2013
|
}
|
|
1452
2014
|
},
|
|
2015
|
+
"401": {
|
|
2016
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2017
|
+
"content": {
|
|
2018
|
+
"application/json": {
|
|
2019
|
+
"schema": {
|
|
2020
|
+
"$ref": "#/components/schemas/Error"
|
|
2021
|
+
},
|
|
2022
|
+
"examples": {
|
|
2023
|
+
"exampleResponse": {
|
|
2024
|
+
"value": {
|
|
2025
|
+
"name": "UnauthorizedError",
|
|
2026
|
+
"message": "errorMessage"
|
|
2027
|
+
}
|
|
2028
|
+
}
|
|
2029
|
+
}
|
|
2030
|
+
}
|
|
2031
|
+
}
|
|
2032
|
+
},
|
|
1453
2033
|
"500": {
|
|
1454
2034
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1455
2035
|
"content": {
|
|
@@ -1556,7 +2136,7 @@
|
|
|
1556
2136
|
"identityProofCreateResponseExample": {
|
|
1557
2137
|
"value": {
|
|
1558
2138
|
"@context": [
|
|
1559
|
-
"https://
|
|
2139
|
+
"https://w3id.org/security/data-integrity/v2",
|
|
1560
2140
|
"https://www.w3.org/ns/credentials/examples/v2"
|
|
1561
2141
|
],
|
|
1562
2142
|
"type": "DataIntegrityProof",
|
|
@@ -1638,6 +2218,11 @@
|
|
|
1638
2218
|
"tags": [
|
|
1639
2219
|
"Identity"
|
|
1640
2220
|
],
|
|
2221
|
+
"security": [
|
|
2222
|
+
{
|
|
2223
|
+
"jwtBearerAuthScheme": []
|
|
2224
|
+
}
|
|
2225
|
+
],
|
|
1641
2226
|
"requestBody": {
|
|
1642
2227
|
"description": "Request to verify a proof.",
|
|
1643
2228
|
"required": true,
|
|
@@ -1669,7 +2254,7 @@
|
|
|
1669
2254
|
}
|
|
1670
2255
|
},
|
|
1671
2256
|
"proof": {
|
|
1672
|
-
"@context": "https://
|
|
2257
|
+
"@context": "https://w3id.org/security/data-integrity/v2",
|
|
1673
2258
|
"type": "DataIntegrityProof",
|
|
1674
2259
|
"cryptosuite": "eddsa-jcs-2022",
|
|
1675
2260
|
"created": "2025-01-24T11:32:13.106Z",
|
|
@@ -1722,6 +2307,24 @@
|
|
|
1722
2307
|
}
|
|
1723
2308
|
}
|
|
1724
2309
|
},
|
|
2310
|
+
"401": {
|
|
2311
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2312
|
+
"content": {
|
|
2313
|
+
"application/json": {
|
|
2314
|
+
"schema": {
|
|
2315
|
+
"$ref": "#/components/schemas/Error"
|
|
2316
|
+
},
|
|
2317
|
+
"examples": {
|
|
2318
|
+
"exampleResponse": {
|
|
2319
|
+
"value": {
|
|
2320
|
+
"name": "UnauthorizedError",
|
|
2321
|
+
"message": "errorMessage"
|
|
2322
|
+
}
|
|
2323
|
+
}
|
|
2324
|
+
}
|
|
2325
|
+
}
|
|
2326
|
+
}
|
|
2327
|
+
},
|
|
1725
2328
|
"500": {
|
|
1726
2329
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1727
2330
|
"content": {
|
|
@@ -1832,7 +2435,7 @@
|
|
|
1832
2435
|
"content": {
|
|
1833
2436
|
"application/json": {
|
|
1834
2437
|
"schema": {
|
|
1835
|
-
"$ref": "#/components/schemas/
|
|
2438
|
+
"$ref": "#/components/schemas/Error"
|
|
1836
2439
|
},
|
|
1837
2440
|
"examples": {
|
|
1838
2441
|
"exampleResponse": {
|
|
@@ -2256,13 +2859,18 @@
|
|
|
2256
2859
|
"example": "role,email,name"
|
|
2257
2860
|
}
|
|
2258
2861
|
],
|
|
2862
|
+
"security": [
|
|
2863
|
+
{
|
|
2864
|
+
"jwtBearerAuthScheme": []
|
|
2865
|
+
}
|
|
2866
|
+
],
|
|
2259
2867
|
"responses": {
|
|
2260
2868
|
"200": {
|
|
2261
2869
|
"description": "Response to get an identity public profile.",
|
|
2262
2870
|
"content": {
|
|
2263
2871
|
"application/ld+json": {
|
|
2264
2872
|
"schema": {
|
|
2265
|
-
"$ref": "
|
|
2873
|
+
"$ref": "#/components/schemas/IdentityProfileGetPublicResponse"
|
|
2266
2874
|
},
|
|
2267
2875
|
"examples": {
|
|
2268
2876
|
"identityGetPublicResponseExample": {
|
|
@@ -2306,6 +2914,24 @@
|
|
|
2306
2914
|
}
|
|
2307
2915
|
}
|
|
2308
2916
|
},
|
|
2917
|
+
"401": {
|
|
2918
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2919
|
+
"content": {
|
|
2920
|
+
"application/json": {
|
|
2921
|
+
"schema": {
|
|
2922
|
+
"$ref": "#/components/schemas/Error"
|
|
2923
|
+
},
|
|
2924
|
+
"examples": {
|
|
2925
|
+
"exampleResponse": {
|
|
2926
|
+
"value": {
|
|
2927
|
+
"name": "UnauthorizedError",
|
|
2928
|
+
"message": "errorMessage"
|
|
2929
|
+
}
|
|
2930
|
+
}
|
|
2931
|
+
}
|
|
2932
|
+
}
|
|
2933
|
+
}
|
|
2934
|
+
},
|
|
2309
2935
|
"404": {
|
|
2310
2936
|
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
2311
2937
|
"content": {
|
|
@@ -2489,25 +3115,18 @@
|
|
|
2489
3115
|
}
|
|
2490
3116
|
},
|
|
2491
3117
|
"components": {
|
|
2492
|
-
"schemas": {
|
|
2493
|
-
"
|
|
2494
|
-
"
|
|
2495
|
-
"
|
|
2496
|
-
"properties": {
|
|
2497
|
-
"conflicts": {
|
|
2498
|
-
"type": "array",
|
|
2499
|
-
"items": {
|
|
2500
|
-
"type": "string"
|
|
2501
|
-
},
|
|
2502
|
-
"description": "The conflicting items."
|
|
2503
|
-
},
|
|
3118
|
+
"schemas": {
|
|
3119
|
+
"Error": {
|
|
3120
|
+
"description": "Model to describe serialized error.",
|
|
3121
|
+
"type": "object",
|
|
3122
|
+
"properties": {
|
|
2504
3123
|
"name": {
|
|
2505
3124
|
"type": "string",
|
|
2506
3125
|
"description": "The name for the error."
|
|
2507
3126
|
},
|
|
2508
3127
|
"message": {
|
|
2509
3128
|
"type": "string",
|
|
2510
|
-
"description": "The message for the error."
|
|
3129
|
+
"description": "The message for the error as an i18n key."
|
|
2511
3130
|
},
|
|
2512
3131
|
"source": {
|
|
2513
3132
|
"type": "string",
|
|
@@ -2527,46 +3146,22 @@
|
|
|
2527
3146
|
}
|
|
2528
3147
|
},
|
|
2529
3148
|
"required": [
|
|
2530
|
-
"
|
|
2531
|
-
"message"
|
|
2532
|
-
|
|
2533
|
-
],
|
|
2534
|
-
"description": "The body which contains the error."
|
|
3149
|
+
"name",
|
|
3150
|
+
"message"
|
|
3151
|
+
]
|
|
2535
3152
|
},
|
|
2536
|
-
"
|
|
3153
|
+
"IdentityAlsoKnownAsCreateRequest": {
|
|
2537
3154
|
"type": "object",
|
|
2538
3155
|
"properties": {
|
|
2539
|
-
"
|
|
2540
|
-
"type": "string",
|
|
2541
|
-
"description": "The name for the error."
|
|
2542
|
-
},
|
|
2543
|
-
"message": {
|
|
2544
|
-
"type": "string",
|
|
2545
|
-
"description": "The message for the error."
|
|
2546
|
-
},
|
|
2547
|
-
"source": {
|
|
2548
|
-
"type": "string",
|
|
2549
|
-
"description": "The source of the error."
|
|
2550
|
-
},
|
|
2551
|
-
"properties": {
|
|
2552
|
-
"type": "object",
|
|
2553
|
-
"additionalProperties": {},
|
|
2554
|
-
"description": "Any additional information for the error."
|
|
2555
|
-
},
|
|
2556
|
-
"stack": {
|
|
3156
|
+
"alias": {
|
|
2557
3157
|
"type": "string",
|
|
2558
|
-
"description": "The
|
|
2559
|
-
},
|
|
2560
|
-
"cause": {
|
|
2561
|
-
"$ref": "#/components/schemas/Error"
|
|
3158
|
+
"description": "The alias to create for the identity."
|
|
2562
3159
|
}
|
|
2563
3160
|
},
|
|
2564
3161
|
"required": [
|
|
2565
|
-
"
|
|
2566
|
-
"message"
|
|
3162
|
+
"alias"
|
|
2567
3163
|
],
|
|
2568
|
-
"
|
|
2569
|
-
"description": "Model to describe serialized error."
|
|
3164
|
+
"description": "The data for the request."
|
|
2570
3165
|
},
|
|
2571
3166
|
"IdentityCreateRequest": {
|
|
2572
3167
|
"type": "object",
|
|
@@ -2576,7 +3171,6 @@
|
|
|
2576
3171
|
"description": "The optional namespace to create the identity in."
|
|
2577
3172
|
}
|
|
2578
3173
|
},
|
|
2579
|
-
"additionalProperties": false,
|
|
2580
3174
|
"description": "The data for the request."
|
|
2581
3175
|
},
|
|
2582
3176
|
"IdentityProfileCreateRequest": {
|
|
@@ -2589,27 +3183,20 @@
|
|
|
2589
3183
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
|
|
2590
3184
|
}
|
|
2591
3185
|
},
|
|
2592
|
-
"additionalProperties": false,
|
|
2593
3186
|
"description": "The data for the request."
|
|
2594
3187
|
},
|
|
3188
|
+
"IdentityProfileGetPublicResponse": {},
|
|
2595
3189
|
"IdentityProfileGetResponse": {
|
|
2596
3190
|
"type": "object",
|
|
2597
3191
|
"properties": {
|
|
2598
3192
|
"identity": {
|
|
2599
3193
|
"type": "string",
|
|
2600
3194
|
"description": "The identity of the profile, this is the authenticated user identity."
|
|
2601
|
-
},
|
|
2602
|
-
"publicProfile": {
|
|
2603
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
|
|
2604
|
-
},
|
|
2605
|
-
"privateProfile": {
|
|
2606
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
|
|
2607
3195
|
}
|
|
2608
3196
|
},
|
|
2609
3197
|
"required": [
|
|
2610
3198
|
"identity"
|
|
2611
3199
|
],
|
|
2612
|
-
"additionalProperties": false,
|
|
2613
3200
|
"description": "The response payload."
|
|
2614
3201
|
},
|
|
2615
3202
|
"IdentityProfileListResponse": {
|
|
@@ -2623,15 +3210,11 @@
|
|
|
2623
3210
|
"identity": {
|
|
2624
3211
|
"type": "string",
|
|
2625
3212
|
"description": "The identity."
|
|
2626
|
-
},
|
|
2627
|
-
"publicProfile": {
|
|
2628
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
|
|
2629
3213
|
}
|
|
2630
3214
|
},
|
|
2631
3215
|
"required": [
|
|
2632
3216
|
"identity"
|
|
2633
|
-
]
|
|
2634
|
-
"additionalProperties": false
|
|
3217
|
+
]
|
|
2635
3218
|
},
|
|
2636
3219
|
"description": "The identities."
|
|
2637
3220
|
},
|
|
@@ -2643,7 +3226,6 @@
|
|
|
2643
3226
|
"required": [
|
|
2644
3227
|
"items"
|
|
2645
3228
|
],
|
|
2646
|
-
"additionalProperties": false,
|
|
2647
3229
|
"description": "The response payload."
|
|
2648
3230
|
},
|
|
2649
3231
|
"IdentityProfileUpdateRequest": {
|
|
@@ -2656,7 +3238,6 @@
|
|
|
2656
3238
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
|
|
2657
3239
|
}
|
|
2658
3240
|
},
|
|
2659
|
-
"additionalProperties": false,
|
|
2660
3241
|
"description": "The data for the request."
|
|
2661
3242
|
},
|
|
2662
3243
|
"IdentityProofCreateRequest": {
|
|
@@ -2673,7 +3254,6 @@
|
|
|
2673
3254
|
"proofType",
|
|
2674
3255
|
"document"
|
|
2675
3256
|
],
|
|
2676
|
-
"additionalProperties": false,
|
|
2677
3257
|
"description": "The data for the request."
|
|
2678
3258
|
},
|
|
2679
3259
|
"IdentityProofVerifyRequest": {
|
|
@@ -2690,7 +3270,6 @@
|
|
|
2690
3270
|
"document",
|
|
2691
3271
|
"proof"
|
|
2692
3272
|
],
|
|
2693
|
-
"additionalProperties": false,
|
|
2694
3273
|
"description": "The data for the request."
|
|
2695
3274
|
},
|
|
2696
3275
|
"IdentityProofVerifyResponse": {
|
|
@@ -2703,7 +3282,6 @@
|
|
|
2703
3282
|
"required": [
|
|
2704
3283
|
"verified"
|
|
2705
3284
|
],
|
|
2706
|
-
"additionalProperties": false,
|
|
2707
3285
|
"description": "The response payload."
|
|
2708
3286
|
},
|
|
2709
3287
|
"IdentityServiceCreateRequest": {
|
|
@@ -2747,7 +3325,6 @@
|
|
|
2747
3325
|
"type",
|
|
2748
3326
|
"endpoint"
|
|
2749
3327
|
],
|
|
2750
|
-
"additionalProperties": false,
|
|
2751
3328
|
"description": "The data for the request."
|
|
2752
3329
|
},
|
|
2753
3330
|
"IdentityVerifiableCredentialCreateRequest": {
|
|
@@ -2767,12 +3344,25 @@
|
|
|
2767
3344
|
"expirationDate": {
|
|
2768
3345
|
"type": "string",
|
|
2769
3346
|
"description": "The date the verifiable credential is valid until."
|
|
3347
|
+
},
|
|
3348
|
+
"jwtHeaderFields": {
|
|
3349
|
+
"type": "object",
|
|
3350
|
+
"additionalProperties": {
|
|
3351
|
+
"type": "string"
|
|
3352
|
+
},
|
|
3353
|
+
"description": "Additional fields to include in the JWT when creating the verifiable credential in jwt format."
|
|
3354
|
+
},
|
|
3355
|
+
"jwtPayloadFields": {
|
|
3356
|
+
"type": "object",
|
|
3357
|
+
"additionalProperties": {
|
|
3358
|
+
"type": "string"
|
|
3359
|
+
},
|
|
3360
|
+
"description": "Additional fields to include in the JWT payload when creating the verifiable credential in jwt format."
|
|
2770
3361
|
}
|
|
2771
3362
|
},
|
|
2772
3363
|
"required": [
|
|
2773
3364
|
"subject"
|
|
2774
3365
|
],
|
|
2775
|
-
"additionalProperties": false,
|
|
2776
3366
|
"description": "The data for the request."
|
|
2777
3367
|
},
|
|
2778
3368
|
"IdentityVerifiableCredentialCreateResponse": {
|
|
@@ -2790,7 +3380,6 @@
|
|
|
2790
3380
|
"verifiableCredential",
|
|
2791
3381
|
"jwt"
|
|
2792
3382
|
],
|
|
2793
|
-
"additionalProperties": false,
|
|
2794
3383
|
"description": "The response payload."
|
|
2795
3384
|
},
|
|
2796
3385
|
"IdentityVerifiableCredentialVerifyResponse": {
|
|
@@ -2807,7 +3396,6 @@
|
|
|
2807
3396
|
"required": [
|
|
2808
3397
|
"revoked"
|
|
2809
3398
|
],
|
|
2810
|
-
"additionalProperties": false,
|
|
2811
3399
|
"description": "The response payload."
|
|
2812
3400
|
},
|
|
2813
3401
|
"IdentityVerifiablePresentationCreateRequest": {
|
|
@@ -2848,15 +3436,28 @@
|
|
|
2848
3436
|
},
|
|
2849
3437
|
"description": "The verifiable credentials to include in the presentation."
|
|
2850
3438
|
},
|
|
2851
|
-
"
|
|
2852
|
-
"type": "
|
|
2853
|
-
"description": "The expiration time for the presentation."
|
|
3439
|
+
"expirationDate": {
|
|
3440
|
+
"type": "string",
|
|
3441
|
+
"description": "The expiration date/time for the presentation."
|
|
3442
|
+
},
|
|
3443
|
+
"jwtHeaderFields": {
|
|
3444
|
+
"type": "object",
|
|
3445
|
+
"additionalProperties": {
|
|
3446
|
+
"type": "string"
|
|
3447
|
+
},
|
|
3448
|
+
"description": "Additional fields to include in the JWT header when creating the verifiable presentation in jwt format."
|
|
3449
|
+
},
|
|
3450
|
+
"jwtPayloadFields": {
|
|
3451
|
+
"type": "object",
|
|
3452
|
+
"additionalProperties": {
|
|
3453
|
+
"type": "string"
|
|
3454
|
+
},
|
|
3455
|
+
"description": "Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format."
|
|
2854
3456
|
}
|
|
2855
3457
|
},
|
|
2856
3458
|
"required": [
|
|
2857
3459
|
"verifiableCredentials"
|
|
2858
3460
|
],
|
|
2859
|
-
"additionalProperties": false,
|
|
2860
3461
|
"description": "The data for the request."
|
|
2861
3462
|
},
|
|
2862
3463
|
"IdentityVerifiablePresentationCreateResponse": {
|
|
@@ -2874,7 +3475,6 @@
|
|
|
2874
3475
|
"verifiablePresentation",
|
|
2875
3476
|
"jwt"
|
|
2876
3477
|
],
|
|
2877
|
-
"additionalProperties": false,
|
|
2878
3478
|
"description": "The response payload."
|
|
2879
3479
|
},
|
|
2880
3480
|
"IdentityVerifiablePresentationVerifyResponse": {
|
|
@@ -2898,7 +3498,6 @@
|
|
|
2898
3498
|
"required": [
|
|
2899
3499
|
"revoked"
|
|
2900
3500
|
],
|
|
2901
|
-
"additionalProperties": false,
|
|
2902
3501
|
"description": "The response payload."
|
|
2903
3502
|
},
|
|
2904
3503
|
"IdentityVerificationMethodCreateRequest": {
|
|
@@ -2915,297 +3514,20 @@
|
|
|
2915
3514
|
"required": [
|
|
2916
3515
|
"verificationMethodType"
|
|
2917
3516
|
],
|
|
2918
|
-
"additionalProperties": false,
|
|
2919
3517
|
"description": "The data for the request."
|
|
2920
3518
|
},
|
|
2921
|
-
"JsonLdDocument": {
|
|
2922
|
-
"type": "object",
|
|
2923
|
-
"properties": {
|
|
2924
|
-
"@context": {
|
|
2925
|
-
"anyOf": [
|
|
2926
|
-
{
|
|
2927
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
2928
|
-
},
|
|
2929
|
-
{
|
|
2930
|
-
"type": "array",
|
|
2931
|
-
"items": {
|
|
2932
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
2933
|
-
}
|
|
2934
|
-
},
|
|
2935
|
-
{
|
|
2936
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
2937
|
-
},
|
|
2938
|
-
{
|
|
2939
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
2940
|
-
},
|
|
2941
|
-
{
|
|
2942
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
2943
|
-
},
|
|
2944
|
-
{
|
|
2945
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
2946
|
-
},
|
|
2947
|
-
{
|
|
2948
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
2949
|
-
},
|
|
2950
|
-
{
|
|
2951
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
|
|
2952
|
-
}
|
|
2953
|
-
]
|
|
2954
|
-
},
|
|
2955
|
-
"@id": {
|
|
2956
|
-
"anyOf": [
|
|
2957
|
-
{
|
|
2958
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
2959
|
-
},
|
|
2960
|
-
{
|
|
2961
|
-
"type": "array",
|
|
2962
|
-
"items": {
|
|
2963
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
2964
|
-
}
|
|
2965
|
-
},
|
|
2966
|
-
{
|
|
2967
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
2968
|
-
},
|
|
2969
|
-
{
|
|
2970
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
2971
|
-
},
|
|
2972
|
-
{
|
|
2973
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
2974
|
-
},
|
|
2975
|
-
{
|
|
2976
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
2977
|
-
},
|
|
2978
|
-
{
|
|
2979
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
2980
|
-
}
|
|
2981
|
-
]
|
|
2982
|
-
},
|
|
2983
|
-
"@included": {
|
|
2984
|
-
"anyOf": [
|
|
2985
|
-
{
|
|
2986
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
2987
|
-
},
|
|
2988
|
-
{
|
|
2989
|
-
"type": "array",
|
|
2990
|
-
"items": {
|
|
2991
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
2992
|
-
}
|
|
2993
|
-
},
|
|
2994
|
-
{
|
|
2995
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
2996
|
-
},
|
|
2997
|
-
{
|
|
2998
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
2999
|
-
},
|
|
3000
|
-
{
|
|
3001
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
3002
|
-
},
|
|
3003
|
-
{
|
|
3004
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
3005
|
-
},
|
|
3006
|
-
{
|
|
3007
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
3008
|
-
}
|
|
3009
|
-
]
|
|
3010
|
-
},
|
|
3011
|
-
"@graph": {
|
|
3012
|
-
"anyOf": [
|
|
3013
|
-
{
|
|
3014
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3015
|
-
},
|
|
3016
|
-
{
|
|
3017
|
-
"type": "array",
|
|
3018
|
-
"items": {
|
|
3019
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3020
|
-
}
|
|
3021
|
-
},
|
|
3022
|
-
{
|
|
3023
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
3024
|
-
},
|
|
3025
|
-
{
|
|
3026
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
3027
|
-
},
|
|
3028
|
-
{
|
|
3029
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
3030
|
-
},
|
|
3031
|
-
{
|
|
3032
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
3033
|
-
},
|
|
3034
|
-
{
|
|
3035
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
3036
|
-
},
|
|
3037
|
-
{
|
|
3038
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdValueObject"
|
|
3039
|
-
},
|
|
3040
|
-
{
|
|
3041
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
3042
|
-
},
|
|
3043
|
-
{
|
|
3044
|
-
"type": "array",
|
|
3045
|
-
"items": {
|
|
3046
|
-
"anyOf": [
|
|
3047
|
-
{
|
|
3048
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdValueObject"
|
|
3049
|
-
},
|
|
3050
|
-
{
|
|
3051
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
3052
|
-
}
|
|
3053
|
-
]
|
|
3054
|
-
}
|
|
3055
|
-
}
|
|
3056
|
-
]
|
|
3057
|
-
},
|
|
3058
|
-
"@nest": {
|
|
3059
|
-
"anyOf": [
|
|
3060
|
-
{
|
|
3061
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3062
|
-
},
|
|
3063
|
-
{
|
|
3064
|
-
"type": "array",
|
|
3065
|
-
"items": {
|
|
3066
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3067
|
-
}
|
|
3068
|
-
},
|
|
3069
|
-
{
|
|
3070
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
3071
|
-
},
|
|
3072
|
-
{
|
|
3073
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
3074
|
-
},
|
|
3075
|
-
{
|
|
3076
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
3077
|
-
},
|
|
3078
|
-
{
|
|
3079
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
3080
|
-
},
|
|
3081
|
-
{
|
|
3082
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
3083
|
-
}
|
|
3084
|
-
]
|
|
3085
|
-
},
|
|
3086
|
-
"@type": {
|
|
3087
|
-
"anyOf": [
|
|
3088
|
-
{
|
|
3089
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3090
|
-
},
|
|
3091
|
-
{
|
|
3092
|
-
"type": "array",
|
|
3093
|
-
"items": {
|
|
3094
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3095
|
-
}
|
|
3096
|
-
},
|
|
3097
|
-
{
|
|
3098
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
3099
|
-
},
|
|
3100
|
-
{
|
|
3101
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
3102
|
-
},
|
|
3103
|
-
{
|
|
3104
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
3105
|
-
},
|
|
3106
|
-
{
|
|
3107
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
3108
|
-
},
|
|
3109
|
-
{
|
|
3110
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
3111
|
-
}
|
|
3112
|
-
]
|
|
3113
|
-
},
|
|
3114
|
-
"@reverse": {
|
|
3115
|
-
"anyOf": [
|
|
3116
|
-
{
|
|
3117
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3118
|
-
},
|
|
3119
|
-
{
|
|
3120
|
-
"type": "array",
|
|
3121
|
-
"items": {
|
|
3122
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3123
|
-
}
|
|
3124
|
-
},
|
|
3125
|
-
{
|
|
3126
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
3127
|
-
},
|
|
3128
|
-
{
|
|
3129
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
3130
|
-
},
|
|
3131
|
-
{
|
|
3132
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
3133
|
-
},
|
|
3134
|
-
{
|
|
3135
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
3136
|
-
},
|
|
3137
|
-
{
|
|
3138
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
3139
|
-
}
|
|
3140
|
-
]
|
|
3141
|
-
},
|
|
3142
|
-
"@index": {
|
|
3143
|
-
"anyOf": [
|
|
3144
|
-
{
|
|
3145
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3146
|
-
},
|
|
3147
|
-
{
|
|
3148
|
-
"type": "array",
|
|
3149
|
-
"items": {
|
|
3150
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
|
|
3151
|
-
}
|
|
3152
|
-
},
|
|
3153
|
-
{
|
|
3154
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
3155
|
-
},
|
|
3156
|
-
{
|
|
3157
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
|
|
3158
|
-
},
|
|
3159
|
-
{
|
|
3160
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
|
|
3161
|
-
},
|
|
3162
|
-
{
|
|
3163
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
|
|
3164
|
-
},
|
|
3165
|
-
{
|
|
3166
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
|
|
3167
|
-
}
|
|
3168
|
-
]
|
|
3169
|
-
}
|
|
3170
|
-
},
|
|
3171
|
-
"additionalProperties": false
|
|
3172
|
-
},
|
|
3173
3519
|
"NotFoundResponse": {
|
|
3174
3520
|
"type": "object",
|
|
3175
|
-
"additionalProperties": false,
|
|
3176
3521
|
"properties": {
|
|
3177
3522
|
"notFoundId": {
|
|
3178
3523
|
"type": "string",
|
|
3179
3524
|
"description": "The id if the item that was not found."
|
|
3180
|
-
},
|
|
3181
|
-
"name": {
|
|
3182
|
-
"type": "string",
|
|
3183
|
-
"description": "The name for the error."
|
|
3184
|
-
},
|
|
3185
|
-
"message": {
|
|
3186
|
-
"type": "string",
|
|
3187
|
-
"description": "The message for the error."
|
|
3188
|
-
},
|
|
3189
|
-
"source": {
|
|
3190
|
-
"type": "string",
|
|
3191
|
-
"description": "The source of the error."
|
|
3192
|
-
},
|
|
3193
|
-
"properties": {
|
|
3194
|
-
"type": "object",
|
|
3195
|
-
"additionalProperties": {},
|
|
3196
|
-
"description": "Any additional information for the error."
|
|
3197
|
-
},
|
|
3198
|
-
"stack": {
|
|
3199
|
-
"type": "string",
|
|
3200
|
-
"description": "The stack trace for the error."
|
|
3201
|
-
},
|
|
3202
|
-
"cause": {
|
|
3203
|
-
"$ref": "#/components/schemas/Error"
|
|
3204
3525
|
}
|
|
3205
3526
|
},
|
|
3206
|
-
"
|
|
3207
|
-
|
|
3208
|
-
|
|
3527
|
+
"allOf": [
|
|
3528
|
+
{
|
|
3529
|
+
"$ref": "#/components/schemas/Error"
|
|
3530
|
+
}
|
|
3209
3531
|
],
|
|
3210
3532
|
"description": "The body which contains the error."
|
|
3211
3533
|
}
|