npm - @twin.org/auditable-item-graph-service - Versions diffs - 0.0.3-next.2 → 0.0.3-next.21 - Mend

@twin.org/auditable-item-graph-service 0.0.3-next.2 → 0.0.3-next.21

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.

Files changed (38) hide show

package/docs/open-api/spec.json CHANGED Viewed

@@ -44,6 +44,11 @@
 							"examples": {
 								"auditableItemGraphCreateRequestExample": {
 									"value": {
+										"@context": [
+											"https://schema.twindev.org/aig/",
+											"https://schema.twindev.org/common/"
+										],
+										"type": "AuditableItemGraphVertex",
 										"annotationObject": {
 											"@context": "https://schema.org",
 											"@type": "Note",
@@ -51,6 +56,7 @@
 										},
 										"aliases": [
 											{
+												"type": "AuditableItemGraphAlias",
 												"id": "bar456",
 												"annotationObject": {
 													"@context": "https://schema.org",
@@ -59,6 +65,7 @@
 												}
 											},
 											{
+												"type": "AuditableItemGraphAlias",
 												"id": "foo321",
 												"annotationObject": {
 													"@context": "https://schema.org",
@@ -69,6 +76,7 @@
 										],
 										"resources": [
 											{
+												"type": "AuditableItemGraphResource",
 												"id": "resource1",
 												"resourceObject": {
 													"@context": "https://schema.org",
@@ -77,6 +85,7 @@
 												}
 											},
 											{
+												"type": "AuditableItemGraphResource",
 												"id": "resource2",
 												"resourceObject": {
 													"@context": "https://schema.org",
@@ -87,6 +96,7 @@
 										],
 										"edges": [
 											{
+												"type": "AuditableItemGraphEdge",
 												"targetId": "aig:1234567890",
 												"edgeRelationships": [
 													"frenemy"
@@ -98,6 +108,7 @@
 												}
 											},
 											{
+												"type": "AuditableItemGraphEdge",
 												"targetId": "aig:45678901234",
 												"edgeRelationships": [
 													"end"
@@ -123,7 +134,7 @@
 								"schema": {
 									"type": "string"
 								},
-								"description": "e.g. aig:1234567890"
+								"description": "e.g. aig%3A1234567890"
 							}
 						}
 					},
@@ -208,11 +219,16 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "string",
-							"enum": [
-								"id",
-								"alias",
-								"both"
+							"anyOf": [
+								{
+									"const": "id"
+								},
+								{
+									"const": "alias"
+								},
+								{
+									"const": "both"
+								}
 							]
 						}
 					},
@@ -249,7 +265,6 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "string",
 							"enum": [
 								"dateCreated",
 								"dateModified"
@@ -350,8 +365,7 @@
 														}
 													]
 												}
-											],
-											"nextItem": "1"
+											]
 										}
 									}
 								}
@@ -395,8 +409,7 @@
 														}
 													]
 												}
-											],
-											"nextItem": "1"
+											]
 										}
 									}
 								}
@@ -499,15 +512,6 @@
 							"type": "string"
 						}
 					},
-					{
-						"name": "includeChangesets",
-						"description": "Whether to include the changesets of the vertex, defaults to false.",
-						"in": "query",
-						"required": false,
-						"schema": {
-							"type": "string"
-						}
-					},
 					{
 						"name": "verifySignatureDepth",
 						"description": "How many signatures to verify, none, current or all, defaults to \"none\".",
@@ -705,7 +709,7 @@
 					}
 				],
 				"requestBody": {
-					"description": "Update an auditable item graph vertex.",
+					"description": "Update an auditable item graph vertex (PUT — full replacement of vertex state).",
 					"required": true,
 					"content": {
 						"application/json": {
@@ -715,6 +719,11 @@
 							"examples": {
 								"auditableItemGraphUpdateRequestExample": {
 									"value": {
+										"@context": [
+											"https://schema.twindev.org/aig/",
+											"https://schema.twindev.org/common/"
+										],
+										"type": "AuditableItemGraphVertex",
 										"annotationObject": {
 											"@context": "https://schema.org",
 											"@type": "Note",
@@ -722,6 +731,7 @@
 										},
 										"aliases": [
 											{
+												"type": "AuditableItemGraphAlias",
 												"id": "bar456",
 												"annotationObject": {
 													"@context": "https://schema.org",
@@ -730,6 +740,7 @@
 												}
 											},
 											{
+												"type": "AuditableItemGraphAlias",
 												"id": "foo321",
 												"annotationObject": {
 													"@context": "https://schema.org",
@@ -740,6 +751,7 @@
 										],
 										"resources": [
 											{
+												"type": "AuditableItemGraphResource",
 												"id": "resource1",
 												"resourceObject": {
 													"@context": "https://schema.org",
@@ -748,6 +760,7 @@
 												}
 											},
 											{
+												"type": "AuditableItemGraphResource",
 												"id": "resource2",
 												"resourceObject": {
 													"@context": "https://schema.org",
@@ -758,6 +771,7 @@
 										],
 										"edges": [
 											{
+												"type": "AuditableItemGraphEdge",
 												"id": "edge1",
 												"targetId": "aig:1234567890",
 												"edgeRelationships": [
@@ -770,6 +784,7 @@
 												}
 											},
 											{
+												"type": "AuditableItemGraphEdge",
 												"id": "edge2",
 												"targetId": "aig:45678901234",
 												"edgeRelationships": [
@@ -850,237 +865,1220 @@
 						}
 					}
 				}
-			}
-		}
-	},
-	"components": {
-		"schemas": {
-			"AuditableItemGraphCreateRequest": {
-				"type": "object",
-				"properties": {
-					"annotationObject": {
-						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-					},
-					"aliases": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"id": {
-									"type": "string"
-								},
-								"aliasFormat": {
-									"type": "string"
-								},
-								"unique": {
-									"type": "boolean"
-								},
-								"annotationObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-								}
-							},
-							"required": [
-								"id"
-							],
-							"additionalProperties": false
+			},
+			"patch": {
+				"operationId": "auditableItemGraphUpdatePartial",
+				"summary": "Partially update a graph vertex",
+				"tags": [
+					"Auditable Item Graph"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the vertex to update.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
 						},
-						"description": "Alternative aliases that can be used to identify the vertex."
-					},
-					"resources": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"id": {
-									"type": "string"
-								},
-								"resourceObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-								}
+						"style": "simple",
+						"example": "aig:1234567890"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Partially update an auditable item graph vertex (PATCH — explicit list patches).",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/AuditableItemGraphUpdatePartialRequest"
 							},
-							"additionalProperties": false
-						},
-						"description": "The resources attached to the vertex."
-					},
-					"edges": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"targetId": {
-									"type": "string"
-								},
-								"edgeRelationships": {
-									"type": "array",
-									"items": {
-										"type": "string"
+							"examples": {
+								"auditableItemGraphUpdatePartialRequestExample": {
+									"value": {
+										"@context": [
+											"https://schema.twindev.org/aig/",
+											"https://schema.twindev.org/common/"
+										],
+										"edgePatches": {
+											"add": [
+												{
+													"type": "AuditableItemGraphEdge",
+													"targetId": "aig:45678901234",
+													"edgeRelationships": [
+														"document"
+													]
+												}
+											]
+										}
 									}
-								},
-								"annotationObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 								}
-							},
-							"required": [
-								"targetId",
-								"edgeRelationships"
-							],
-							"additionalProperties": false
-						},
-						"description": "The edges connected to the vertex."
+							}
+						}
 					}
 				},
-				"additionalProperties": false,
-				"description": "The data to be used in the vertex."
-			},
-			"AuditableItemGraphUpdateRequest": {
-				"type": "object",
-				"properties": {
-					"annotationObject": {
-						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
 					},
-					"aliases": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"id": {
-									"type": "string"
-								},
-								"aliasFormat": {
-									"type": "string"
-								},
-								"unique": {
-									"type": "boolean"
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
 								},
-								"annotationObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
 								}
-							},
-							"required": [
-								"id"
-							],
-							"additionalProperties": false
-						},
-						"description": "Alternative aliases that can be used to identify the vertex."
+							}
+						}
 					},
-					"resources": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"id": {
-									"type": "string"
+					"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"
 								},
-								"resourceObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
 								}
-							},
-							"additionalProperties": false
-						},
-						"description": "The resources attached to the vertex."
+							}
+						}
 					},
-					"edges": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"id": {
-									"type": "string"
-								},
-								"targetId": {
-									"type": "string"
+					"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"
 								},
-								"edgeRelationships": {
-									"type": "array",
-									"items": {
-										"type": "string"
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
 									}
-								},
-								"annotationObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 								}
-							},
-							"required": [
-								"targetId",
-								"edgeRelationships"
-							],
-							"additionalProperties": false
-						},
-						"description": "The edges connected to the vertex."
-					}
-				},
-				"additionalProperties": false,
-				"description": "The data to be used in the vertex."
-			},
-			"Error": {
-				"type": "object",
-				"properties": {
-					"name": {
-						"type": "string",
-						"description": "The name for the error."
-					},
-					"message": {
-						"type": "string",
-						"description": "The message for the error."
-					},
-					"source": {
-						"type": "string",
-						"description": "The source of the error."
-					},
-					"properties": {
-						"type": "object",
-						"additionalProperties": {},
-						"description": "Any additional information for the error."
-					},
-					"stack": {
-						"type": "string",
-						"description": "The stack trace for the error."
-					},
-					"cause": {
-						"$ref": "#/components/schemas/Error"
+							}
+						}
 					}
-				},
-				"required": [
-					"name",
-					"message"
+				}
+			}
+		},
+		"/auditable-item-graph/{id}/versions/{version}": {
+			"get": {
+				"operationId": "auditableItemGraphVersionGet",
+				"summary": "Get a graph vertex at a specific version",
+				"tags": [
+					"Auditable Item Graph"
 				],
-				"additionalProperties": false,
-				"description": "Model to describe serialized error."
-			},
-			"SortDirection": {
-				"anyOf": [
+				"parameters": [
 					{
-						"type": "string",
-						"const": "asc",
-						"description": "Ascending."
+						"name": "id",
+						"description": "The id of the vertex.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:1234567890"
 					},
 					{
-						"type": "string",
-						"const": "desc",
-						"description": "Descending."
+						"name": "version",
+						"description": "The version number to get.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "1"
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "application/json"
 					}
 				],
-				"description": "The sort directions."
-			},
-			"VerifyDepth": {
-				"anyOf": [
-					{
-						"type": "string",
-						"const": "none",
-						"description": "Do not verify any signatures."
-					},
+				"security": [
 					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting an auditable item graph vertex at a specific version.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertex"
+								},
+								"examples": {
+									"auditableItemGraphVersionGetResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/aig/",
+												"https://schema.twindev.org/common/",
+												"https://schema.org"
+											],
+											"type": "AuditableItemGraphVertex",
+											"id": "aig:1234567890",
+											"dateCreated": "2024-08-22T11:55:16.271Z",
+											"version": 1
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/auditable-item-graph/{id}/versions": {
+			"get": {
+				"operationId": "auditableItemGraphVersionList",
+				"summary": "Get all versions of a graph vertex",
+				"tags": [
+					"Auditable Item Graph"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the vertex.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:1234567890"
+					},
+					{
+						"name": "after",
+						"description": "Only return versions created after this ISO 8601 timestamp (exclusive).",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "before",
+						"description": "Only return versions created before this ISO 8601 timestamp (exclusive).",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "application/json"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting all versions of an auditable item graph vertex.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertexVersionList"
+								},
+								"examples": {
+									"auditableItemGraphVersionListResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/aig/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemGraphVertexVersionList"
+											],
+											"itemListElement": [
+												{
+													"version": 0,
+													"dateCreated": "2024-08-22T11:55:16.271Z"
+												},
+												{
+													"version": 1,
+													"dateCreated": "2024-08-22T11:56:00.000Z"
+												},
+												{
+													"version": 2,
+													"dateCreated": "2024-08-22T11:57:00.000Z"
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/auditable-item-graph/{id}/changesets/{changesetId}": {
+			"get": {
+				"operationId": "auditableItemGraphChangesetGet",
+				"summary": "Get a graph vertex changeset",
+				"tags": [
+					"Auditable Item Graph"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the vertex to get the changeset from.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:1234567890"
+					},
+					{
+						"name": "changesetId",
+						"description": "The id of the changeset to get.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "changeset:1234567890"
+					},
+					{
+						"name": "verifySignatureDepth",
+						"description": "How many signatures to verify, none, current or all, defaults to \"none\".",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/VerifyDepth"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "application/json"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting an auditable item graph vertex changeset.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/aig/AuditableItemGraphChangeset"
+								},
+								"examples": {
+									"auditableItemGraphChangesetGetResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/aig/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": "AuditableItemGraphChangeset",
+											"id": "aig:1234567890",
+											"dateCreated": "2024-08-22T11:55:16.271Z",
+											"patches": [
+												{
+													"type": "AuditableItemGraphPatchOperation",
+													"patchOperation": "add",
+													"patchPath": "/annotationObject",
+													"patchValue": {
+														"@context": "https://www.w3.org/ns/activitystreams",
+														"type": "Create",
+														"actor": {
+															"type": "Person",
+															"id": "acct:person@example.org",
+															"name": "Person"
+														},
+														"object": {
+															"type": "Note",
+															"content": "This is a simple note"
+														},
+														"published": "2015-01-25T12:34:56Z"
+													}
+												},
+												{
+													"type": "AuditableItemGraphPatchOperation",
+													"patchOperation": "add",
+													"patchPath": "/aliases",
+													"patchValue": [
+														{
+															"id": "foo123",
+															"dateCreated": "2015-01-25T12:34:56Z"
+														},
+														{
+															"id": "bar456",
+															"dateCreated": "2015-01-25T12:34:56Z"
+														}
+													]
+												}
+											],
+											"verification": {
+												"@context": "https://schema.twindev.org/immutable-proof/",
+												"type": "ImmutableProofVerification",
+												"verified": true
+											}
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/aig/AuditableItemGraphChangeset"
+								},
+								"examples": {
+									"auditableItemGraphChangesetJsonLdGetResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/aig/",
+												"https://schema.twindev.org/common/",
+												"https://schema.org"
+											],
+											"type": "AuditableItemGraphChangeset",
+											"id": "aig:1234567890",
+											"dateCreated": "2024-08-22T11:55:16.271Z",
+											"patches": [
+												{
+													"type": "AuditableItemGraphPatchOperation",
+													"patchOperation": "add",
+													"patchPath": "/annotationObject",
+													"patchValue": {
+														"@context": "https://www.w3.org/ns/activitystreams",
+														"type": "Create",
+														"actor": {
+															"type": "Person",
+															"id": "acct:person@example.org",
+															"name": "Person"
+														},
+														"object": {
+															"type": "Note",
+															"content": "This is a simple note"
+														},
+														"published": "2015-01-25T12:34:56Z"
+													}
+												},
+												{
+													"type": "AuditableItemGraphPatchOperation",
+													"patchOperation": "add",
+													"patchPath": "/aliases",
+													"patchValue": [
+														{
+															"id": "foo123",
+															"dateCreated": "2015-01-25T12:34:56Z"
+														},
+														{
+															"id": "bar456",
+															"dateCreated": "2015-01-25T12:34:56Z"
+														}
+													]
+												}
+											],
+											"verification": {
+												"@context": "https://schema.twindev.org/immutable-proof/",
+												"type": "ImmutableProofVerification",
+												"verified": true
+											}
+										}
+									}
+								}
+							}
+						},
+						"headers": {
+							"content-type": {
+								"schema": {
+									"type": "string"
+								},
+								"description": "e.g. application/ld+json"
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/auditable-item-graph/{id}/changesets": {
+			"get": {
+				"operationId": "auditableItemGraphChangesetList",
+				"summary": "Get a list of graph vertex changesets",
+				"tags": [
+					"Auditable Item Graph"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the changeset to get.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:1234567890"
+					},
+					{
+						"name": "cursor",
+						"description": "The optional cursor to get next chunk.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "Limit the number of entities to return.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "verifySignatureDepth",
+						"description": "How many signatures to verify, none, current or all, defaults to \"none\".",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/VerifyDepth"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "application/json"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting an auditable item graph vertex changeset.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/aig/AuditableItemGraphChangesetList"
+								},
+								"examples": {
+									"auditableItemGraphChangesetListResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/aig/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemGraphChangesetList"
+											],
+											"itemListElement": [
+												{
+													"type": "AuditableItemGraphChangeset",
+													"id": "aig:1234567890",
+													"dateCreated": "2024-08-22T11:55:16.271Z",
+													"patches": [
+														{
+															"type": "AuditableItemGraphPatchOperation",
+															"patchOperation": "add",
+															"patchPath": "/annotationObject",
+															"patchValue": {
+																"@context": "https://www.w3.org/ns/activitystreams",
+																"type": "Create",
+																"actor": {
+																	"type": "Person",
+																	"id": "acct:person@example.org",
+																	"name": "Person"
+																},
+																"object": {
+																	"type": "Note",
+																	"content": "This is a simple note"
+																},
+																"published": "2015-01-25T12:34:56Z"
+															}
+														},
+														{
+															"type": "AuditableItemGraphPatchOperation",
+															"patchOperation": "add",
+															"patchPath": "/aliases",
+															"patchValue": [
+																{
+																	"id": "foo123",
+																	"dateCreated": "2015-01-25T12:34:56Z"
+																},
+																{
+																	"id": "bar456",
+																	"dateCreated": "2015-01-25T12:34:56Z"
+																}
+															]
+														}
+													],
+													"verification": {
+														"@context": "https://schema.twindev.org/immutable-proof/",
+														"type": "ImmutableProofVerification",
+														"verified": true
+													}
+												}
+											]
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/aig/AuditableItemGraphChangeset"
+								},
+								"examples": {
+									"auditableItemGraphChangesetJsonLdGetResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/aig/",
+												"https://schema.twindev.org/common/",
+												"https://schema.org"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemGraphChangesetList"
+											],
+											"itemListElement": [
+												{
+													"type": "AuditableItemGraphChangeset",
+													"id": "aig:1234567890",
+													"dateCreated": "2024-08-22T11:55:16.271Z",
+													"patches": [
+														{
+															"type": "AuditableItemGraphPatchOperation",
+															"patchOperation": "add",
+															"patchPath": "/annotationObject",
+															"patchValue": {
+																"@context": "https://www.w3.org/ns/activitystreams",
+																"type": "Create",
+																"actor": {
+																	"type": "Person",
+																	"id": "acct:person@example.org",
+																	"name": "Person"
+																},
+																"object": {
+																	"type": "Note",
+																	"content": "This is a simple note"
+																},
+																"published": "2015-01-25T12:34:56Z"
+															}
+														},
+														{
+															"type": "AuditableItemGraphPatchOperation",
+															"patchOperation": "add",
+															"patchPath": "/aliases",
+															"patchValue": [
+																{
+																	"id": "foo123",
+																	"dateCreated": "2015-01-25T12:34:56Z"
+																},
+																{
+																	"id": "bar456",
+																	"dateCreated": "2015-01-25T12:34:56Z"
+																}
+															]
+														}
+													],
+													"verification": {
+														"@context": "https://schema.twindev.org/immutable-proof/",
+														"type": "ImmutableProofVerification",
+														"verified": true
+													}
+												}
+											]
+										}
+									}
+								}
+							}
+						},
+						"headers": {
+							"content-type": {
+								"schema": {
+									"type": "string"
+								},
+								"description": "e.g. application/ld+json"
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"components": {
+		"schemas": {
+			"AuditableItemGraphCreateRequest": {
+				"description": "The data to be used in the vertex.",
+				"type": "object",
+				"properties": {
+					"dateCreated": {
+						"type": "string",
+						"description": "The date/time of when the element was created."
+					},
+					"dateModified": {
+						"type": "string",
+						"description": "The date/time of when the element was modified."
+					},
+					"dateDeleted": {
+						"type": "string",
+						"description": "The date/time of when the element was deleted, as we never actually remove items."
+					},
+					"@context": {
+						"type": "array",
+						"prefixItems": [
+							{
+								"const": "https://schema.twindev.org/aig/"
+							},
+							{
+								"const": "https://schema.twindev.org/common/"
+							}
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						},
+						"minItems": 2,
+						"description": "JSON-LD Context."
+					},
+					"type": {
+						"const": "AuditableItemGraphVertex",
+						"description": "JSON-LD Type."
+					},
+					"organizationIdentity": {
+						"type": "string",
+						"description": "The identity of the organization which controls the vertex."
+					},
+					"annotationObject": {
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+					},
+					"aliases": {
+						"type": "array",
+						"items": {
+							"$ref": "https://schema.twindev.org/aig/AuditableItemGraphAlias"
+						},
+						"description": "Alternative aliases that can be used to identify the vertex."
+					},
+					"resources": {
+						"type": "array",
+						"items": {
+							"$ref": "https://schema.twindev.org/aig/AuditableItemGraphResource"
+						},
+						"description": "The resources attached to the vertex."
+					},
+					"edges": {
+						"type": "array",
+						"items": {
+							"$ref": "https://schema.twindev.org/aig/AuditableItemGraphEdge"
+						},
+						"description": "Edges connected to the vertex."
+					},
+					"verified": {
+						"type": "boolean",
+						"description": "Is the vertex verified, will only be populated when verification is requested."
+					},
+					"version": {
+						"type": "number",
+						"description": "The version of the vertex, populated only when getting a specific version.\nMaps to https://schema.org/version."
+					}
+				},
+				"required": [
+					"@context",
+					"type"
+				]
+			},
+			"AuditableItemGraphUpdatePartialRequest": {
+				"description": "Partial vertex data; only defined properties are applied.\nSub-lists use `{ add, remove }` patch objects.",
+				"type": "object",
+				"properties": {
+					"dateCreated": {
+						"type": "string",
+						"description": "The date/time of when the element was created."
+					},
+					"dateModified": {
+						"type": "string",
+						"description": "The date/time of when the element was modified."
+					},
+					"dateDeleted": {
+						"type": "string",
+						"description": "The date/time of when the element was deleted, as we never actually remove items."
+					},
+					"@context": {
+						"type": "array",
+						"prefixItems": [
+							{
+								"const": "https://schema.twindev.org/aig/"
+							},
+							{
+								"const": "https://schema.twindev.org/common/"
+							}
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						},
+						"minItems": 2,
+						"description": "JSON-LD Context."
+					},
+					"organizationIdentity": {
+						"type": "string",
+						"description": "The identity of the organization which controls the vertex."
+					},
+					"annotationObject": {
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+					},
+					"verified": {
+						"type": "boolean",
+						"description": "Is the vertex verified, will only be populated when verification is requested."
+					},
+					"version": {
+						"type": "number",
+						"description": "The version of the vertex, populated only when getting a specific version.\nMaps to https://schema.org/version."
+					},
+					"type": {
+						"const": "AuditableItemGraphVertex",
+						"description": "JSON-LD Type."
+					},
+					"aliasPatches": {
+						"$ref": "https://schema.twindev.org/aig/AuditableItemGraphListPatch"
+					},
+					"resourcePatches": {
+						"$ref": "https://schema.twindev.org/aig/AuditableItemGraphListPatch"
+					},
+					"edgePatches": {
+						"$ref": "https://schema.twindev.org/aig/AuditableItemGraphListPatch"
+					}
+				},
+				"required": [
+					"@context"
+				]
+			},
+			"AuditableItemGraphUpdateRequest": {
+				"description": "The full vertex payload. Replaces annotation and active sub-lists; omitted collections are cleared.",
+				"type": "object",
+				"properties": {
+					"dateCreated": {
+						"type": "string",
+						"description": "The date/time of when the element was created."
+					},
+					"dateModified": {
+						"type": "string",
+						"description": "The date/time of when the element was modified."
+					},
+					"dateDeleted": {
+						"type": "string",
+						"description": "The date/time of when the element was deleted, as we never actually remove items."
+					},
+					"@context": {
+						"type": "array",
+						"prefixItems": [
+							{
+								"const": "https://schema.twindev.org/aig/"
+							},
+							{
+								"const": "https://schema.twindev.org/common/"
+							}
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						},
+						"minItems": 2,
+						"description": "JSON-LD Context."
+					},
+					"type": {
+						"const": "AuditableItemGraphVertex",
+						"description": "JSON-LD Type."
+					},
+					"organizationIdentity": {
+						"type": "string",
+						"description": "The identity of the organization which controls the vertex."
+					},
+					"annotationObject": {
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+					},
+					"aliases": {
+						"type": "array",
+						"items": {
+							"$ref": "https://schema.twindev.org/aig/AuditableItemGraphAlias"
+						},
+						"description": "Alternative aliases that can be used to identify the vertex."
+					},
+					"resources": {
+						"type": "array",
+						"items": {
+							"$ref": "https://schema.twindev.org/aig/AuditableItemGraphResource"
+						},
+						"description": "The resources attached to the vertex."
+					},
+					"edges": {
+						"type": "array",
+						"items": {
+							"$ref": "https://schema.twindev.org/aig/AuditableItemGraphEdge"
+						},
+						"description": "Edges connected to the vertex."
+					},
+					"verified": {
+						"type": "boolean",
+						"description": "Is the vertex verified, will only be populated when verification is requested."
+					},
+					"version": {
+						"type": "number",
+						"description": "The version of the vertex, populated only when getting a specific version.\nMaps to https://schema.org/version."
+					}
+				},
+				"required": [
+					"@context",
+					"type"
+				]
+			},
+			"Error": {
+				"description": "Model to describe serialized error.",
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string",
+						"description": "The name for the error."
+					},
+					"message": {
+						"type": "string",
+						"description": "The message for the error as an i18n key."
+					},
+					"source": {
+						"type": "string",
+						"description": "The source of the error."
+					},
+					"properties": {
+						"type": "object",
+						"additionalProperties": {},
+						"description": "Any additional information for the error."
+					},
+					"stack": {
 						"type": "string",
+						"description": "The stack trace for the error."
+					},
+					"cause": {
+						"$ref": "#/components/schemas/Error"
+					}
+				},
+				"required": [
+					"name",
+					"message"
+				]
+			},
+			"SortDirection": {
+				"description": "The sort directions.",
+				"anyOf": [
+					{
+						"const": "asc",
+						"description": "Ascending."
+					},
+					{
+						"const": "desc",
+						"description": "Descending."
+					}
+				]
+			},
+			"VerifyDepth": {
+				"description": "How deep to verify the signatures.",
+				"anyOf": [
+					{
+						"const": "none",
+						"description": "Do not verify any signatures."
+					},
+					{
 						"const": "current",
 						"description": "Verify only the most recent signature."
 					},
 					{
-						"type": "string",
 						"const": "all",
 						"description": "Verify all the signatures."
 					}
-				],
-				"description": "How deep to verify the signatures."
+				]
 			}
 		},
 		"securitySchemes": {