@twin.org/node 0.0.3-next.21 → 0.0.3-next.22

package/docs/open-api/spec.json

@@ -2467,6 +2467,132 @@
 				}
 			}
 		},
+		"/identity/verifiable-credential/verify/document": {
+			"post": {
+				"operationId": "identityVerifiableCredentialVerifyDocument",
+				"summary": "Verify an identity verifiable credential document",
+				"tags": [
+					"Identity"
+				],
+				"requestBody": {
+					"description": "Request to verify a verifiable credential.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "https://schema.twindev.org/w3c-did/DidVerifiableCredential"
+							},
+							"examples": {
+								"identityVerifiableCredentialVerifyDocumentRequestExample": {
+									"value": {
+										"@context": [
+											"https://www.w3.org/2018/credentials/v1",
+											"https://schema.org"
+										],
+										"id": "https://example.com/credentials/3732",
+										"type": [
+											"VerifiableCredential",
+											"Person"
+										],
+										"credentialSubject": {
+											"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+											"name": "Jane Doe"
+										},
+										"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
+										"issuanceDate": "2025-01-24T09:21:51.500Z",
+										"credentialStatus": {
+											"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
+											"type": "BitstringStatusList",
+											"revocationBitmapIndex": "5"
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "Response to verifying a verifiable credential.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/IdentityVerifiableCredentialVerifyResponse"
+								},
+								"examples": {
+									"identityVerifiableCredentialVerifyResponseExample": {
+										"value": {
+											"revoked": false,
+											"verifiableCredential": {
+												"@context": [
+													"https://www.w3.org/2018/credentials/v1",
+													"https://schema.org"
+												],
+												"id": "https://example.com/credentials/3732",
+												"type": [
+													"VerifiableCredential",
+													"Person"
+												],
+												"credentialSubject": {
+													"id": "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+													"name": "Jane Doe"
+												},
+												"issuer": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
+												"issuanceDate": "2025-01-24T09:21:51.500Z",
+												"credentialStatus": {
+													"id": "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
+													"type": "BitstringStatusList",
+													"revocationBitmapIndex": "5"
+												}
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
 		"/identity/verifiable-credential/verify": {
 			"get": {
 				"operationId": "identityVerifiableCredentialVerify",
@@ -2486,17 +2612,6 @@
 						"example": "eyJraWQiOi...D1Z3AQ"
 					}
 				],
-				"requestBody": {
-					"description": "Request to verify a verifiable credential.",
-					"required": true,
-					"content": {
-						"application/json": {
-							"schema": {
-								"$ref": "#/components/schemas/IdentityVerifiableCredentialVerifyRequest"
-							}
-						}
-					}
-				},
 				"responses": {
 					"200": {
 						"description": "Response to verifying a verifiable credential.",
@@ -12662,25 +12777,14 @@
 				}
 			}
 		},
-		"/ais/{id}/entries/objects": {
+		"/ais/entries": {
 			"get": {
-				"operationId": "auditableItemStreamListEntryObjects",
-				"summary": "Get the entry objects in a stream",
+				"operationId": "auditableItemStreamListEntriesNoStream",
+				"summary": "Get the entry objects for all streams",
 				"tags": [
 					"Auditable Item Stream"
 				],
 				"parameters": [
-					{
-						"name": "id",
-						"description": "The id of the stream to get.",
-						"in": "path",
-						"required": true,
-						"schema": {
-							"type": "string"
-						},
-						"style": "simple",
-						"example": "ais:1234567890"
-					},
 					{
 						"name": "conditions",
 						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
@@ -12699,6 +12803,15 @@
 							"type": "string"
 						}
 					},
+					{
+						"name": "verifyEntries",
+						"description": "Should the entries be verified, defaults to false.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
 					{
 						"name": "order",
 						"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
@@ -12743,14 +12856,14 @@
 				],
 				"responses": {
 					"200": {
-						"description": "Response to getting an auditable item stream entries objects.",
+						"description": "Response to getting an auditable item stream entries.",
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
 								},
 								"examples": {
-									"auditableItemStreamListEntryObjectsResponseExample": {
+									"auditableItemStreamListEntriesNoStreamResponseExample": {
 										"value": {
 											"@context": [
 												"https://schema.org",
@@ -12759,20 +12872,78 @@
 											],
 											"type": [
 												"ItemList",
-												"AuditableItemStreamEntryObjectList"
+												"AuditableItemStreamEntryList"
 											],
 											"itemListElement": [
 												{
-													"@context": "https://schema.org",
-													"@type": "Event",
-													"startDate": "2011-04-09T20:00:00Z",
-													"description": "A description of the event"
+													"@context": [
+														"https://schema.twindev.org/ais/",
+														"https://schema.twindev.org/common/"
+													],
+													"type": "AuditableItemStreamEntry",
+													"id": "tst:1234567890",
+													"dateCreated": "2024-08-22T11:55:16.271Z",
+													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
+													"index": 0,
+													"entryObject": {
+														"@context": "https://schema.org",
+														"@type": "Event",
+														"startDate": "2011-04-09T20:00:00Z",
+														"description": "A description of the event"
+													}
+												}
+											]
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
+								},
+								"examples": {
+									"auditableItemStreamJsonLdListEntriesNoStreamResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/ais/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemStreamEntryList"
+											],
+											"itemListElement": [
+												{
+													"@context": [
+														"https://schema.twindev.org/ais/",
+														"https://schema.twindev.org/common/"
+													],
+													"type": "AuditableItemStreamEntry",
+													"id": "tst:1234567890",
+													"dateCreated": "2024-08-22T11:55:16.271Z",
+													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
+													"index": 0,
+													"entryObject": {
+														"@context": "https://schema.org",
+														"@type": "Event",
+														"startDate": "2011-04-09T20:00:00Z",
+														"description": "A description of the event"
+													}
 												}
 											]
 										}
 									}
 								}
 							}
+						},
+						"headers": {
+							"content-type": {
+								"schema": {
+									"type": "string"
+								},
+								"description": "e.g. application/ld+json"
+							}
 						}
 					},
 					"400": {
@@ -12856,47 +13027,424 @@
 				}
 			}
 		},
-		"/synchronised-storage/sync-changeset": {
-			"post": {
-				"operationId": "synchronisedStorageSyncChangeSetRequest",
-				"summary": "Request that the node perform a sync request for a changeset.",
+		"/ais/{id}/entries/objects": {
+			"get": {
+				"operationId": "auditableItemStreamListEntryObjects",
+				"summary": "Get the entry objects in a stream",
 				"tags": [
-					"Synchronised Storage"
+					"Auditable Item Stream"
 				],
 				"parameters": [
 					{
-						"name": "accept",
-						"in": "header",
+						"name": "id",
+						"description": "The id of the stream to get.",
+						"in": "path",
 						"required": true,
 						"schema": {
 							"type": "string"
 						},
-						"style": "simple"
+						"style": "simple",
+						"example": "ais:1234567890"
 					},
 					{
-						"name": "authorization",
-						"in": "header",
-						"required": true,
+						"name": "conditions",
+						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"in": "query",
+						"required": false,
 						"schema": {
 							"type": "string"
-						},
-						"style": "simple",
-						"example": "z3V32BP9ShC...z3V32BP9ShC"
-					}
-				],
-				"requestBody": {
-					"description": "Request a trusted node to perform a sync request for a changeset.",
-					"required": true,
-					"content": {
-						"application/json": {
-							"schema": {
-								"$ref": "#/components/schemas/SyncChangeSet"
-							},
-							"examples": {
-								"synchronisedStorageSyncChangeSetRequestExample": {
-									"value": {
-										"@context": "https://schema.twindev.org/synchronised-storage/",
-										"type": "ChangeSet",
+						}
+					},
+					{
+						"name": "includeDeleted",
+						"description": "Whether to include deleted entries, defaults to false.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "order",
+						"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/SortDirection"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "How many entries to return.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "cursor",
+						"description": "Cursor to use for next chunk of data.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting an auditable item stream entries objects.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
+								},
+								"examples": {
+									"auditableItemStreamListEntryObjectsResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/ais/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemStreamEntryObjectList"
+											],
+											"itemListElement": [
+												{
+													"@context": "https://schema.org",
+													"@type": "Event",
+													"startDate": "2011-04-09T20:00:00Z",
+													"description": "A description of the event"
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "The resource you tried to access does not exist, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/NotFoundResponse"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "NotFoundError",
+											"message": "errorMessage",
+											"properties": {
+												"notFoundId": "1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/ais/entries/objects": {
+			"get": {
+				"operationId": "auditableItemStreamListEntryObjectsNoStream",
+				"summary": "Get the entry objects for all streams",
+				"tags": [
+					"Auditable Item Stream"
+				],
+				"parameters": [
+					{
+						"name": "conditions",
+						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "includeDeleted",
+						"description": "Whether to include deleted entries, defaults to false.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "order",
+						"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/SortDirection"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "How many entries to return.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "cursor",
+						"description": "Cursor to use for next chunk of data.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting an auditable item stream entries objects.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
+								},
+								"examples": {
+									"auditableItemStreamListEntryObjectsNoStreamResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/ais/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemStreamEntryObjectList"
+											],
+											"itemListElement": [
+												{
+													"@context": "https://schema.org",
+													"@type": "Event",
+													"startDate": "2011-04-09T20:00:00Z",
+													"description": "A description of the event"
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "The resource you tried to access does not exist, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/NotFoundResponse"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "NotFoundError",
+											"message": "errorMessage",
+											"properties": {
+												"notFoundId": "1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/synchronised-storage/sync-changeset": {
+			"post": {
+				"operationId": "synchronisedStorageSyncChangeSetRequest",
+				"summary": "Request that the node perform a sync request for a changeset.",
+				"tags": [
+					"Synchronised Storage"
+				],
+				"parameters": [
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					},
+					{
+						"name": "authorization",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "z3V32BP9ShC...z3V32BP9ShC"
+					}
+				],
+				"requestBody": {
+					"description": "Request a trusted node to perform a sync request for a changeset.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/SyncChangeSet"
+							},
+							"examples": {
+								"synchronisedStorageSyncChangeSetRequestExample": {
+									"value": {
+										"@context": "https://schema.twindev.org/synchronised-storage/",
+										"type": "ChangeSet",
 										"id": "0909090909090909090909090909090909090909090909090909090909090909",
 										"dateCreated": "2025-05-29T01:00:00.000Z",
 										"dateModified": "2025-05-29T01:00:00.000Z",
@@ -19784,19 +20332,6 @@
 				"additionalProperties": false,
 				"description": "The response payload."
 			},
-			"IdentityVerifiableCredentialVerifyRequest": {
-				"type": "object",
-				"properties": {
-					"credential": {
-						"$ref": "https://schema.twindev.org/w3c-did/DidVerifiableCredential"
-					}
-				},
-				"required": [
-					"credential"
-				],
-				"additionalProperties": false,
-				"description": "The body parameters."
-			},
 			"IdentityVerifiableCredentialVerifyResponse": {
 				"type": "object",
 				"properties": {