@twin.org/immutable-proof-service 0.0.2-next.3 → 0.0.3-next.10

package/docs/open-api/spec.json

@@ -63,7 +63,7 @@
 								"schema": {
 									"type": "string"
 								},
-								"description": "e.g. test:1234567890"
+								"description": "e.g. test%3A1234567890"
 							}
 						}
 					},
@@ -165,7 +165,7 @@
 							"type": "string"
 						},
 						"style": "simple",
-						"example": "ais:1234567890"
+						"example": "immutable-proof:1234567890"
 					},
 					{
 						"name": "accept",
@@ -189,28 +189,37 @@
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProof"
+									"$ref": "#/components/schemas/DidVerifiableCredential"
 								},
 								"examples": {
 									"immutableProofGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://www.w3.org/2018/credentials/v1",
 												"https://schema.twindev.org/immutable-proof/",
 												"https://schema.twindev.org/common/"
 											],
-											"type": "ImmutableProof",
-											"id": "ais:1234567890",
-											"nodeIdentity": "node-1",
-											"userIdentity": "user-1",
-											"proofObjectId": "test:1234567890",
-											"proofObjectHash": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y=",
+											"type": [
+												"VerifiableCredential",
+												"ImmutableProof"
+											],
+											"id": "immutable-proof:1234567890",
+											"credentialSubject": {
+												"id": "ais:1234567890",
+												"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
+											},
 											"proof": {
-												"@context": "https://www.w3.org/ns/credentials/v2",
 												"type": "DataIntegrityProof",
 												"cryptosuite": "eddsa-jcs-2022",
 												"created": "2024-08-22T11:56:56.272Z",
 												"proofPurpose": "assertionMethod",
-												"proofValue": "7DdiPPYtxLjCD3wA1po2rv..."
+												"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
+												"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
+												"verifiableStorageId": "verifiable-storage:1234567890",
+												"immutableReceipt": {
+													"id": "immutable-receipt:1234567890",
+													"type": "ImmutableReceipt"
+												}
 											}
 										}
 									}
@@ -218,28 +227,37 @@
 							},
 							"application/ld+json": {
 								"schema": {
-									"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProof"
+									"$ref": "#/components/schemas/DidVerifiableCredential"
 								},
 								"examples": {
 									"immutableProofJsonLdGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://www.w3.org/2018/credentials/v1",
 												"https://schema.twindev.org/immutable-proof/",
 												"https://schema.twindev.org/common/"
 											],
-											"type": "ImmutableProof",
-											"id": "ais:1234567890",
-											"nodeIdentity": "node-1",
-											"userIdentity": "user-1",
-											"proofObjectId": "test:1234567890",
-											"proofObjectHash": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y=",
+											"type": [
+												"VerifiableCredential",
+												"ImmutableProof"
+											],
+											"id": "immutable-proof:1234567890",
+											"credentialSubject": {
+												"id": "ais:1234567890",
+												"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
+											},
 											"proof": {
-												"@context": "https://www.w3.org/ns/credentials/v2",
 												"type": "DataIntegrityProof",
 												"cryptosuite": "eddsa-jcs-2022",
 												"created": "2024-08-22T11:56:56.272Z",
 												"proofPurpose": "assertionMethod",
-												"proofValue": "7DdiPPYtxLjCD3wA1po2rv..."
+												"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
+												"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
+												"verifiableStorageId": "verifiable-storage:1234567890",
+												"immutableReceipt": {
+													"id": "immutable-receipt:1234567890",
+													"type": "ImmutableReceipt"
+												}
 											}
 										}
 									}
@@ -353,7 +371,7 @@
 							"type": "string"
 						},
 						"style": "simple",
-						"example": "ais:1234567890"
+						"example": "immutable-proof:1234567890"
 					},
 					{
 						"name": "accept",
@@ -391,7 +409,7 @@
 											"@context": "https://schema.twindev.org/immutable-proof/",
 											"type": "ImmutableProofVerification",
 											"verified": false,
-											"failure": "proofTypeMismatch"
+											"failure": "verificationFailure"
 										}
 									}
 								}
@@ -489,20 +507,20 @@
 						"anyOf": [
 							{
 								"type": "string",
-								"const": "https://www.w3.org/ns/credentials/v2"
+								"const": "https://w3id.org/security/data-integrity/v2"
 							},
 							{
 								"type": "array",
 								"minItems": 1,
-								"items": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-								},
 								"prefixItems": [
 									{
 										"type": "string",
-										"const": "https://www.w3.org/ns/credentials/v2"
+										"const": "https://w3id.org/security/data-integrity/v2"
 									}
-								]
+								],
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+								}
 							}
 						],
 						"description": "JSON-LD Context."
@@ -554,12 +572,9 @@
 							},
 							{
 								"type": "array",
-								"items": false,
-								"prefixItems": [
-									{
-										"type": "string"
-									}
-								]
+								"items": {
+									"type": "string"
+								}
 							}
 						],
 						"description": "One or more security domains in which the proof is meant to be used."
@@ -571,12 +586,9 @@
 							},
 							{
 								"type": "array",
-								"items": false,
-								"prefixItems": [
-									{
-										"type": "string"
-									}
-								]
+								"items": {
+									"type": "string"
+								}
 							}
 						],
 						"description": "Provided to mitigate replay attacks on domains."
@@ -595,9 +607,47 @@
 					"cryptosuite",
 					"proofPurpose"
 				],
-				"additionalProperties": false,
 				"description": "Interface describing a did proof. https://www.w3.org/TR/vc-data-integrity/"
 			},
+			"DidCredentialSchema": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string",
+						"description": "The URI id."
+					},
+					"type": {
+						"type": "string",
+						"description": "The credential schema type."
+					}
+				},
+				"required": [
+					"id",
+					"type"
+				],
+				"description": "Interface describing a DID credential schema."
+			},
+			"DidCredentialStatus": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string",
+						"description": "The URI id."
+					},
+					"type": {
+						"type": "string",
+						"description": "The credential status type."
+					}
+				},
+				"required": [
+					"id",
+					"type"
+				],
+				"additionalProperties": {
+					"description": "Additional properties."
+				},
+				"description": "Interface describing a DID credential status."
+			},
 			"DidCryptoSuites": {
 				"anyOf": [
 					{
@@ -613,6 +663,441 @@
 				],
 				"description": "The types for DID Proof crypto suites."
 			},
+			"DidLabel": {
+				"type": "object",
+				"properties": {
+					"@value": {
+						"type": "string",
+						"description": "The value for the label."
+					},
+					"@language": {
+						"type": "string",
+						"description": "The language for the label."
+					},
+					"@direction": {
+						"type": "string",
+						"description": "The direction of the label."
+					}
+				},
+				"required": [
+					"@value",
+					"@language"
+				],
+				"description": "Interface describing a DID Label."
+			},
+			"DidVerifiableCredential": {
+				"anyOf": [
+					{
+						"$ref": "#/components/schemas/DidVerifiableCredentialV1"
+					},
+					{
+						"$ref": "#/components/schemas/DidVerifiableCredentialV2"
+					}
+				],
+				"description": "Interface describing a verifiable credential."
+			},
+			"DidVerifiableCredentialV1": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string",
+						"description": "The identifier for the verifiable credential."
+					},
+					"type": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "array",
+								"items": {
+									"type": "string"
+								}
+							}
+						],
+						"description": "The types of the data stored in the verifiable credential."
+					},
+					"credentialSubject": {
+						"anyOf": [
+							{
+								"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							}
+						],
+						"description": "The data for the verifiable credential."
+					},
+					"credentialStatus": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schemas/DidCredentialStatus"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidCredentialStatus"
+								}
+							}
+						],
+						"description": "Used to discover information about the current status of the verifiable credential, such as whether it is suspended or revoked."
+					},
+					"credentialSchema": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schemas/DidCredentialSchema"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidCredentialSchema"
+								}
+							}
+						],
+						"description": "Annotate type definitions or lock them to specific versions of the vocabulary."
+					},
+					"issuer": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "object",
+								"properties": {
+									"id": {
+										"type": "string"
+									},
+									"name": {
+										"anyOf": [
+											{
+												"type": "string"
+											},
+											{
+												"type": "array",
+												"items": {
+													"$ref": "#/components/schemas/DidLabel"
+												}
+											}
+										]
+									},
+									"description": {
+										"anyOf": [
+											{
+												"type": "string"
+											},
+											{
+												"type": "array",
+												"items": {
+													"$ref": "#/components/schemas/DidLabel"
+												}
+											}
+										]
+									}
+								},
+								"required": [
+									"id"
+								]
+							}
+						],
+						"description": "The issuing identity."
+					},
+					"name": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidLabel"
+								}
+							}
+						],
+						"description": "The name of the credential."
+					},
+					"description": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidLabel"
+								}
+							}
+						],
+						"description": "The description of the credential."
+					},
+					"evidence": {
+						"anyOf": [
+							{
+								"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							}
+						],
+						"description": "Evidence associated with the Credential."
+					},
+					"proof": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schemas/Proof"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/Proof"
+								}
+							}
+						],
+						"description": "Proofs that the verifiable credential is valid. Optional if a different proof method is used, such as JWT."
+					},
+					"@context": {
+						"anyOf": [
+							{
+								"type": "string",
+								"const": "https://www.w3.org/2018/credentials/v1"
+							},
+							{
+								"type": "array",
+								"minItems": 1,
+								"prefixItems": [
+									{
+										"type": "string",
+										"const": "https://www.w3.org/2018/credentials/v1"
+									}
+								],
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+								}
+							}
+						],
+						"description": "The context for the verifiable credential."
+					},
+					"issuanceDate": {
+						"type": "string",
+						"description": "The date the verifiable credential was issued, depending on version validFrom might be set instead."
+					},
+					"expirationDate": {
+						"type": "string",
+						"description": "The date the verifiable credential expires, depending on version validUntil might be set instead."
+					}
+				},
+				"required": [
+					"@context",
+					"type"
+				],
+				"description": "Interface describing a verifiable credential. https://www.w3.org/TR/vc-data-model-1.1"
+			},
+			"DidVerifiableCredentialV2": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string",
+						"description": "The identifier for the verifiable credential."
+					},
+					"type": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "array",
+								"items": {
+									"type": "string"
+								}
+							}
+						],
+						"description": "The types of the data stored in the verifiable credential."
+					},
+					"credentialSubject": {
+						"anyOf": [
+							{
+								"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							}
+						],
+						"description": "The data for the verifiable credential."
+					},
+					"credentialStatus": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schemas/DidCredentialStatus"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidCredentialStatus"
+								}
+							}
+						],
+						"description": "Used to discover information about the current status of the verifiable credential, such as whether it is suspended or revoked."
+					},
+					"credentialSchema": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schemas/DidCredentialSchema"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidCredentialSchema"
+								}
+							}
+						],
+						"description": "Annotate type definitions or lock them to specific versions of the vocabulary."
+					},
+					"issuer": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "object",
+								"properties": {
+									"id": {
+										"type": "string"
+									},
+									"name": {
+										"anyOf": [
+											{
+												"type": "string"
+											},
+											{
+												"type": "array",
+												"items": {
+													"$ref": "#/components/schemas/DidLabel"
+												}
+											}
+										]
+									},
+									"description": {
+										"anyOf": [
+											{
+												"type": "string"
+											},
+											{
+												"type": "array",
+												"items": {
+													"$ref": "#/components/schemas/DidLabel"
+												}
+											}
+										]
+									}
+								},
+								"required": [
+									"id"
+								]
+							}
+						],
+						"description": "The issuing identity."
+					},
+					"name": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidLabel"
+								}
+							}
+						],
+						"description": "The name of the credential."
+					},
+					"description": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DidLabel"
+								}
+							}
+						],
+						"description": "The description of the credential."
+					},
+					"evidence": {
+						"anyOf": [
+							{
+								"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							}
+						],
+						"description": "Evidence associated with the Credential."
+					},
+					"proof": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schemas/Proof"
+							},
+							{
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/Proof"
+								}
+							}
+						],
+						"description": "Proofs that the verifiable credential is valid. Optional if a different proof method is used, such as JWT."
+					},
+					"@context": {
+						"anyOf": [
+							{
+								"type": "string",
+								"const": "https://www.w3.org/ns/credentials/v2"
+							},
+							{
+								"type": "array",
+								"minItems": 1,
+								"prefixItems": [
+									{
+										"type": "string",
+										"const": "https://www.w3.org/ns/credentials/v2"
+									}
+								],
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+								}
+							}
+						],
+						"description": "The context for the verifiable credential."
+					},
+					"validFrom": {
+						"type": "string",
+						"description": "The date the verifiable credential is valid from."
+					},
+					"validUntil": {
+						"type": "string",
+						"description": "The date the verifiable credential is valid until."
+					}
+				},
+				"required": [
+					"@context",
+					"type"
+				],
+				"description": "Interface describing a verifiable credential. https://www.w3.org/TR/vc-data-model-2.0"
+			},
 			"Error": {
 				"type": "object",
 				"properties": {
@@ -645,7 +1130,6 @@
 					"name",
 					"message"
 				],
-				"additionalProperties": false,
 				"description": "Model to describe serialized error."
 			},
 			"ImmutableProofCreateRequest": {
@@ -658,12 +1142,63 @@
 				"required": [
 					"document"
 				],
-				"additionalProperties": false,
 				"description": "The parameters from the body."
 			},
+			"JsonWebSignature2020Proof": {
+				"type": "object",
+				"properties": {
+					"@context": {
+						"anyOf": [
+							{
+								"type": "string",
+								"const": "https://w3id.org/security/suites/jws-2020/v1"
+							},
+							{
+								"type": "array",
+								"minItems": 1,
+								"prefixItems": [
+									{
+										"type": "string",
+										"const": "https://w3id.org/security/suites/jws-2020/v1"
+									}
+								],
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+								}
+							}
+						],
+						"description": "JSON-LD Context."
+					},
+					"type": {
+						"type": "string",
+						"const": "JsonWebSignature2020",
+						"description": "JSON-LD Type."
+					},
+					"proofPurpose": {
+						"type": "string",
+						"description": "The reason the proof was created."
+					},
+					"verificationMethod": {
+						"type": "string",
+						"description": "The verification method of the proof."
+					},
+					"created": {
+						"type": "string",
+						"description": "The iso date of when the proof was created."
+					},
+					"jws": {
+						"type": "string",
+						"description": "The JSON Web Signature."
+					}
+				},
+				"required": [
+					"type",
+					"proofPurpose"
+				],
+				"description": "Interface describing a did proof in JSON Web Signature 2020 Format. https://www.w3.org/TR/vc-jws-2020/"
+			},
 			"NotFoundResponse": {
 				"type": "object",
-				"additionalProperties": false,
 				"properties": {
 					"notFoundId": {
 						"type": "string",
@@ -699,6 +1234,17 @@
 					"name"
 				],
 				"description": "The body which contains the error."
+			},
+			"Proof": {
+				"anyOf": [
+					{
+						"$ref": "#/components/schemas/DataIntegrityProof"
+					},
+					{
+						"$ref": "#/components/schemas/JsonWebSignature2020Proof"
+					}
+				],
+				"description": "Interface describing a proof."
 			}
 		},
 		"securitySchemes": {