@twin.org/document-management-service 0.0.1-next.9 → 0.0.1

package/docs/open-api/spec.json

@@ -21,7 +21,7 @@
 		}
 	],
 	"paths": {
-		"/documents": {
+		"/document-management": {
 			"post": {
 				"operationId": "DocumentManagementSet",
 				"summary": "Store a document in an auditable item graph vertex and add its content to blob storage.",
@@ -163,7 +163,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "string"
+							"type": [
+								"number",
+								"string"
+							]
 						}
 					},
 					{
@@ -182,6 +185,80 @@
 					}
 				],
 				"responses": {
+					"200": {
+						"description": "Response to query the documents from an auditable item graph vertex.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertexList"
+								},
+								"examples": {
+									"DocumentManagementQueryResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/aig/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemGraphVertexList"
+											],
+											"itemListElement": [
+												{
+													"@context": [
+														"https://schema.twindev.org/aig/",
+														"https://schema.twindev.org/common/"
+													],
+													"id": "aig:c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7",
+													"type": "AuditableItemGraphVertex",
+													"dateCreated": "2024-08-22T04:13:20.000Z",
+													"aliases": [
+														{
+															"@context": [
+																"https://schema.twindev.org/aig/"
+															],
+															"id": "test-id-0",
+															"type": "AuditableItemGraphAlias",
+															"dateCreated": "2024-08-22T04:13:20.000Z"
+														}
+													],
+													"resources": [
+														{
+															"@context": "https://schema.twindev.org/aig/",
+															"type": "AuditableItemGraphResource",
+															"dateCreated": "2024-08-22T04:13:20.000Z",
+															"resourceObject": {
+																"@context": [
+																	"https://schema.twindev.org/documents/",
+																	"https://schema.twindev.org/common/",
+																	"https://schema.org"
+																],
+																"type": "Document",
+																"id": "test-id-0:0",
+																"documentId": "test-id-0",
+																"documentCode": "unece:DocumentCodeList#705",
+																"documentRevision": 0,
+																"annotationObject": {
+																	"@context": "https://schema.org",
+																	"type": "DigitalDocument",
+																	"name": "bill-of-lading"
+																},
+																"blobHash": "sha256:E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
+																"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
+																"dateCreated": "2024-08-22T04:13:20.000Z",
+																"nodeIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
+																"userIdentity": "did:entity-storage:0x0404040404040404040404040404040404040404040404040404040404040404"
+															}
+														}
+													]
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
 					"400": {
 						"description": "The server cannot process the request, see the content for more details.",
 						"content": {
@@ -242,7 +319,7 @@
 				}
 			}
 		},
-		"/documents/{auditableItemGraphDocumentId}": {
+		"/document-management/{auditableItemGraphDocumentId}": {
 			"put": {
 				"operationId": "DocumentManagementUpdate",
 				"summary": "Update a document in an auditable item graph vertex and add its content to blob storage.",
@@ -377,7 +454,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "boolean"
+							"type": [
+								"boolean",
+								"string"
+							]
 						}
 					},
 					{
@@ -386,7 +466,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "boolean"
+							"type": [
+								"boolean",
+								"string"
+							]
 						}
 					},
 					{
@@ -395,7 +478,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "boolean"
+							"type": [
+								"boolean",
+								"string"
+							]
 						}
 					},
 					{
@@ -404,7 +490,28 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "boolean"
+							"type": [
+								"boolean",
+								"string"
+							]
+						}
+					},
+					{
+						"name": "extractRuleGroupId",
+						"description": "If provided will extract data from the document using the specified rule group id.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "extractMimeType",
+						"description": "By default extraction will auto detect the mime type of the document, this can be used to override the detection.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
 						}
 					},
 					{
@@ -413,7 +520,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "string"
+							"type": [
+								"number",
+								"string"
+							]
 						}
 					},
 					{
@@ -452,11 +562,12 @@
 									"DocumentManagementGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://schema.org",
 												"https://schema.twindev.org/documents/",
 												"https://schema.twindev.org/common/"
 											],
-											"type": "DocumentList",
-											"documents": [
+											"type": "ItemList",
+											"itemListElement": [
 												{
 													"@context": [
 														"https://schema.twindev.org/documents/",
@@ -493,11 +604,12 @@
 									"DocumentManagementGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://schema.org",
 												"https://schema.twindev.org/documents/",
 												"https://schema.twindev.org/common/"
 											],
-											"type": "DocumentList",
-											"documents": [
+											"type": "ItemList",
+											"itemListElement": [
 												{
 													"@context": [
 														"https://schema.twindev.org/documents/",
@@ -609,7 +721,192 @@
 				}
 			}
 		},
-		"/documents/{auditableItemGraphDocumentId}/{revision}": {
+		"/document-management/{auditableItemGraphDocumentId}/{revision}": {
+			"get": {
+				"operationId": "DocumentManagementGetRevision",
+				"summary": "Get the data for a document revision from document management",
+				"tags": [
+					"Document Management"
+				],
+				"parameters": [
+					{
+						"name": "auditableItemGraphDocumentId",
+						"description": "",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:123456"
+					},
+					{
+						"name": "revision",
+						"description": "",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "1"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to get a document revision from an auditable item graph vertex.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Document"
+								},
+								"examples": {
+									"DocumentManagementGetRevisionResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/documents/",
+												"https://schema.twindev.org/common/",
+												"https://schema.org"
+											],
+											"type": "Document",
+											"id": "2721000:0",
+											"documentId": "2721000",
+											"documentIdFormat": "bol",
+											"documentCode": "unece:DocumentCodeList#705",
+											"documentRevision": 1,
+											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+											"blobHash": "sha256:123456",
+											"dateCreated": "2024-01-01T00:00:00Z",
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											},
+											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "#/components/schemas/Document"
+								},
+								"examples": {
+									"DocumentManagementGetRevisionResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/documents/",
+												"https://schema.twindev.org/common/",
+												"https://schema.org"
+											],
+											"type": "Document",
+											"id": "2721000:0",
+											"documentId": "2721000",
+											"documentIdFormat": "bol",
+											"documentCode": "unece:DocumentCodeList#705",
+											"documentRevision": 1,
+											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+											"blobHash": "sha256:123456",
+											"dateCreated": "2024-01-01T00:00:00Z",
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											},
+											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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": "component.error",
+											"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": "component.error"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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": "component.error",
+											"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": "component.error"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
 			"delete": {
 				"operationId": "DocumentManagementRemove",
 				"summary": "Remove an document from an auditable item graph vertex",
@@ -733,16 +1030,17 @@
 	},
 	"components": {
 		"schemas": {
-			"AttestationInformation": {
+			"Document": {
 				"type": "object",
 				"properties": {
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": [
+						"description": "JSON-LD Context.",
+						"prefixItems": [
 							{
 								"type": "string",
-								"const": "https://schema.twindev.org/attestation/"
+								"const": "https://schema.twindev.org/documents/"
 							},
 							{
 								"type": "string",
@@ -753,283 +1051,144 @@
 								"const": "https://schema.org"
 							}
 						],
-						"additionalItems": {
-							"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
-						},
-						"description": "JSON-LD Context."
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
-						"const": "Information",
+						"const": "Document",
 						"description": "JSON-LD Type."
 					},
 					"id": {
 						"type": "string",
-						"description": "The unique identifier of the attestation."
+						"description": "The full id of the document."
 					},
-					"dateCreated": {
+					"documentId": {
+						"type": "string",
+						"description": "The id of the document."
+					},
+					"documentIdFormat": {
+						"type": "string",
+						"description": "The format of the document id."
+					},
+					"documentCode": {
+						"$ref": "#/components/schemas/UneceDocumentCodes"
+					},
+					"documentRevision": {
+						"type": "number",
+						"description": "The revision of the document as a 0 based index."
+					},
+					"annotationObject": {
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+					},
+					"blobStorageId": {
 						"type": "string",
-						"description": "Created date/time of the attestation in ISO format."
+						"description": "The blob storage id for the document."
 					},
-					"dateTransferred": {
+					"blobHash": {
 						"type": "string",
-						"description": "Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner."
+						"description": "The hash of the blob data."
+					},
+					"blobStorageEntry": {
+						"$ref": "https://schema.twindev.org/blob-storage/BlobStorageEntry"
+					},
+					"extractedData": {
+						"description": "The data extracted from the document using data extraction services."
 					},
-					"ownerIdentity": {
+					"attestationId": {
 						"type": "string",
-						"description": "The identity of the owner."
+						"description": "The attestation for the document if one was created."
 					},
-					"holderIdentity": {
+					"attestationInformation": {
+						"$ref": "https://schema.twindev.org/attestation/AttestationInformation"
+					},
+					"dateCreated": {
 						"type": "string",
-						"description": "The identity of the current holder, can be undefined if owner is still the holder."
+						"description": "The date/time of when the document was created."
 					},
-					"attestationObject": {
-						"$ref": "#/components/schemas/JsonLdNodeObject"
+					"dateModified": {
+						"type": "string",
+						"description": "The date/time of when the document was modified."
 					},
-					"proof": {
-						"$ref": "#/components/schemas/JsonLdNodeObject"
+					"dateDeleted": {
+						"type": "string",
+						"description": "The date/time of when the document was deleted, as we never actually remove items."
 					},
-					"verified": {
-						"type": "boolean",
-						"description": "Whether the attestation has been verified."
+					"nodeIdentity": {
+						"type": "string",
+						"description": "The node which added the document to the graph."
 					},
-					"verificationFailure": {
+					"userIdentity": {
 						"type": "string",
-						"description": "The verification failure message."
+						"description": "The user who added the document to the graph."
 					}
 				},
 				"required": [
 					"@context",
 					"type",
 					"id",
+					"documentId",
+					"documentCode",
+					"documentRevision",
+					"blobStorageId",
+					"blobHash",
 					"dateCreated",
-					"ownerIdentity",
-					"attestationObject"
+					"nodeIdentity",
+					"userIdentity"
 				],
 				"additionalProperties": false,
-				"description": "Interface describing the collated attestation information."
+				"description": "Interface describing a document."
 			},
-			"BlobStorageEntry": {
+			"DocumentList": {
 				"type": "object",
 				"properties": {
 					"@context": {
 						"type": "array",
-						"minItems": 2,
-						"items": [
+						"minItems": 3,
+						"description": "JSON-LD Context.",
+						"prefixItems": [
+							{
+								"type": "string",
+								"const": "https://schema.org"
+							},
 							{
 								"type": "string",
-								"const": "https://schema.twindev.org/blob-storage/"
+								"const": "https://schema.twindev.org/documents/"
 							},
 							{
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
 						],
-						"additionalItems": {
-							"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
-						},
-						"description": "JSON-LD Context."
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
-						"const": "BlobStorageEntry",
+						"const": "ItemList",
 						"description": "JSON-LD Type."
 					},
-					"id": {
-						"type": "string",
-						"description": "The id for the blob."
-					},
-					"dateCreated": {
-						"type": "string",
-						"description": "The date/time when the entry was created."
+					"itemListElement": {
+						"type": "array",
+						"description": "The list of documents.",
+						"prefixItems": [
+							{
+								"$ref": "#/components/schemas/Document"
+							}
+						]
 					},
-					"dateModified": {
-						"type": "string",
-						"description": "The date/time when the entry was modified."
-					},
-					"blobSize": {
-						"type": "number",
-						"description": "The size of the data in the blob."
-					},
-					"blobHash": {
-						"type": "string",
-						"description": "The hash of the data in the blob."
-					},
-					"encodingFormat": {
-						"type": "string",
-						"description": "The mime type for the blob."
-					},
-					"fileExtension": {
-						"type": "string",
-						"description": "The extension."
-					},
-					"metadata": {
-						"$ref": "#/components/schemas/JsonLdNodeObject"
-					},
-					"blob": {
-						"type": "string",
-						"description": "The blob in base64 format, included if the includeContent flag was set in the request."
-					}
-				},
-				"required": [
-					"@context",
-					"type",
-					"id",
-					"dateCreated",
-					"blobSize",
-					"blobHash"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a blob storage entry."
-			},
-			"Document": {
-				"type": "object",
-				"properties": {
-					"@context": {
-						"type": "array",
-						"minItems": 3,
-						"items": [
-							{
-								"type": "string",
-								"const": "https://schema.twindev.org/documents/"
-							},
-							{
-								"type": "string",
-								"const": "https://schema.twindev.org/common/"
-							},
-							{
-								"type": "string",
-								"const": "https://schema.org"
-							}
-						],
-						"additionalItems": {
-							"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
-						},
-						"description": "JSON-LD Context."
-					},
-					"type": {
-						"type": "string",
-						"const": "Document",
-						"description": "JSON-LD Type."
-					},
-					"id": {
-						"type": "string",
-						"description": "The full id of the document."
-					},
-					"documentId": {
-						"type": "string",
-						"description": "The id of the document."
-					},
-					"documentIdFormat": {
-						"type": "string",
-						"description": "The format of the document id."
-					},
-					"documentCode": {
-						"$ref": "#/components/schemas/UneceDocumentCodes"
-					},
-					"documentRevision": {
-						"type": "number",
-						"description": "The revision of the document as a 0 based index."
-					},
-					"annotationObject": {
-						"$ref": "#/components/schemas/JsonLdNodeObject"
-					},
-					"blobStorageId": {
-						"type": "string",
-						"description": "The blob storage id for the document."
-					},
-					"blobHash": {
-						"type": "string",
-						"description": "The hash of the blob data."
-					},
-					"blobStorageEntry": {
-						"$ref": "#/components/schemas/BlobStorageEntry"
-					},
-					"attestationId": {
-						"type": "string",
-						"description": "The attestation for the document if one was created."
-					},
-					"attestationInformation": {
-						"$ref": "#/components/schemas/AttestationInformation"
-					},
-					"dateCreated": {
-						"type": "string",
-						"description": "The date/time of when the document was created."
-					},
-					"dateModified": {
-						"type": "string",
-						"description": "The date/time of when the document was modified."
-					},
-					"dateDeleted": {
-						"type": "string",
-						"description": "The date/time of when the document was deleted, as we never actually remove items."
-					},
-					"nodeIdentity": {
-						"type": "string",
-						"description": "The node which added the document to the graph."
-					},
-					"userIdentity": {
-						"type": "string",
-						"description": "The user who added the document to the graph."
-					}
-				},
-				"required": [
-					"@context",
-					"type",
-					"id",
-					"documentId",
-					"documentCode",
-					"documentRevision",
-					"blobStorageId",
-					"blobHash",
-					"dateCreated",
-					"nodeIdentity",
-					"userIdentity"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a document."
-			},
-			"DocumentList": {
-				"type": "object",
-				"properties": {
-					"@context": {
+					"edges": {
 						"type": "array",
-						"minItems": 2,
-						"items": [
-							{
-								"type": "string",
-								"const": "https://schema.twindev.org/documents/"
-							},
+						"description": "The ids of the other vertices which are connected to the document.",
+						"prefixItems": [
 							{
-								"type": "string",
-								"const": "https://schema.twindev.org/common/"
+								"type": "string"
 							}
-						],
-						"additionalItems": {
-							"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
-						},
-						"description": "JSON-LD Context."
-					},
-					"type": {
-						"type": "string",
-						"const": "DocumentList",
-						"description": "JSON-LD Type."
-					},
-					"documents": {
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schemas/Document"
-						},
-						"description": "The list of documents."
-					},
-					"edges": {
-						"type": "array",
-						"items": {
-							"type": "string"
-						},
-						"description": "The ids of the other vertices which are connected to the document."
+						]
 					},
-					"cursor": {
+					"nextItem": {
 						"type": "string",
 						"description": "The cursor to get the next chunk of documents."
 					}
@@ -1037,7 +1196,7 @@
 				"required": [
 					"@context",
 					"type",
-					"documents"
+					"itemListElement"
 				],
 				"additionalProperties": false,
 				"description": "Interface describing a list of document entries."
@@ -1061,29 +1220,31 @@
 						"description": "The data to create the document with, in base64."
 					},
 					"annotationObject": {
-						"$ref": "#/components/schemas/JsonLdNodeObject"
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 					},
 					"auditableItemGraphEdges": {
 						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"id": {
-									"type": "string"
-								},
-								"addAlias": {
-									"type": "boolean"
+						"description": "The auditable item graph vertices to connect the document to.",
+						"prefixItems": [
+							{
+								"type": "object",
+								"properties": {
+									"id": {
+										"type": "string"
+									},
+									"addAlias": {
+										"type": "boolean"
+									},
+									"aliasAnnotationObject": {
+										"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+									}
 								},
-								"aliasAnnotationObject": {
-									"$ref": "#/components/schemas/JsonLdNodeObject"
-								}
-							},
-							"required": [
-								"id"
-							],
-							"additionalProperties": false
-						},
-						"description": "The auditable item graph vertices to connect the document to."
+								"required": [
+									"id"
+								],
+								"additionalProperties": false
+							}
+						]
 					},
 					"createAttestation": {
 						"type": "boolean",
@@ -1094,7 +1255,7 @@
 						"description": "Flag to add the document id as an alias to the aig vertex, defaults to true."
 					},
 					"aliasAnnotationObject": {
-						"$ref": "#/components/schemas/JsonLdNodeObject"
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 					}
 				},
 				"required": [
@@ -1113,29 +1274,31 @@
 						"description": "The data to create the document with, in base64."
 					},
 					"annotationObject": {
-						"$ref": "#/components/schemas/JsonLdNodeObject"
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 					},
 					"auditableItemGraphEdges": {
 						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"id": {
-									"type": "string"
-								},
-								"addAlias": {
-									"type": "boolean"
+						"description": "The auditable item graph vertices to connect the document to.",
+						"prefixItems": [
+							{
+								"type": "object",
+								"properties": {
+									"id": {
+										"type": "string"
+									},
+									"addAlias": {
+										"type": "boolean"
+									},
+									"aliasAnnotationObject": {
+										"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+									}
 								},
-								"aliasAnnotationObject": {
-									"$ref": "#/components/schemas/JsonLdNodeObject"
-								}
-							},
-							"required": [
-								"id"
-							],
-							"additionalProperties": false
-						},
-						"description": "The auditable item graph vertices to connect the document to."
+								"required": [
+									"id"
+								],
+								"additionalProperties": false
+							}
+						]
 					}
 				},
 				"additionalProperties": false,
@@ -1176,1075 +1339,6 @@
 				"additionalProperties": false,
 				"description": "Model to describe serialized error."
 			},
-			"JsonLdContainerType": {
-				"type": "string",
-				"enum": [
-					"@language",
-					"@index",
-					"@id",
-					"@graph",
-					"@type"
-				],
-				"description": "Helper Types"
-			},
-			"JsonLdContainerTypeArray": {
-				"anyOf": [
-					{
-						"type": "array",
-						"minItems": 2,
-						"items": [
-							{
-								"type": "string",
-								"const": "@graph"
-							},
-							{
-								"type": "string",
-								"const": "@id"
-							}
-						],
-						"maxItems": 2
-					},
-					{
-						"type": "array",
-						"minItems": 2,
-						"items": [
-							{
-								"type": "string",
-								"const": "@id"
-							},
-							{
-								"type": "string",
-								"const": "@graph"
-							}
-						],
-						"maxItems": 2
-					},
-					{
-						"type": "array",
-						"minItems": 3,
-						"items": [
-							{
-								"type": "string",
-								"const": "@set"
-							},
-							{
-								"type": "string",
-								"const": "@graph"
-							},
-							{
-								"type": "string",
-								"const": "@id"
-							}
-						],
-						"maxItems": 3
-					},
-					{
-						"type": "array",
-						"minItems": 3,
-						"items": [
-							{
-								"type": "string",
-								"const": "@set"
-							},
-							{
-								"type": "string",
-								"const": "@id"
-							},
-							{
-								"type": "string",
-								"const": "@graph"
-							}
-						],
-						"maxItems": 3
-					},
-					{
-						"type": "array",
-						"minItems": 3,
-						"items": [
-							{
-								"type": "string",
-								"const": "@graph"
-							},
-							{
-								"type": "string",
-								"const": "@set"
-							},
-							{
-								"type": "string",
-								"const": "@id"
-							}
-						],
-						"maxItems": 3
-					},
-					{
-						"type": "array",
-						"minItems": 3,
-						"items": [
-							{
-								"type": "string",
-								"const": "@id"
-							},
-							{
-								"type": "string",
-								"const": "@set"
-							},
-							{
-								"type": "string",
-								"const": "@graph"
-							}
-						],
-						"maxItems": 3
-					},
-					{
-						"type": "array",
-						"minItems": 3,
-						"items": [
-							{
-								"type": "string",
-								"const": "@graph"
-							},
-							{
-								"type": "string",
-								"const": "@id"
-							},
-							{
-								"type": "string",
-								"const": "@set"
-							}
-						],
-						"maxItems": 3
-					},
-					{
-						"type": "array",
-						"minItems": 3,
-						"items": [
-							{
-								"type": "string",
-								"const": "@id"
-							},
-							{
-								"type": "string",
-								"const": "@graph"
-							},
-							{
-								"type": "string",
-								"const": "@set"
-							}
-						],
-						"maxItems": 3
-					},
-					{
-						"type": "array",
-						"minItems": 2,
-						"items": [
-							{
-								"type": "string",
-								"const": "@set"
-							},
-							{
-								"$ref": "#/components/schemas/JsonLdContainerType"
-							}
-						],
-						"maxItems": 2
-					},
-					{
-						"type": "array",
-						"minItems": 2,
-						"items": [
-							{
-								"$ref": "#/components/schemas/JsonLdContainerType"
-							},
-							{
-								"type": "string",
-								"const": "@set"
-							}
-						],
-						"maxItems": 2
-					}
-				],
-				"description": "Helper Types."
-			},
-			"JsonLdContextDefinition": {
-				"type": "object",
-				"properties": {
-					"@base": {
-						"type": [
-							"string",
-							"null"
-						]
-					},
-					"@direction": {
-						"type": [
-							"string",
-							"null"
-						],
-						"enum": [
-							"ltr",
-							"rtl",
-							null
-						]
-					},
-					"@import": {
-						"type": "string"
-					},
-					"@language": {
-						"type": "string"
-					},
-					"@propagate": {
-						"type": "boolean"
-					},
-					"@protected": {
-						"type": "boolean"
-					},
-					"@type": {
-						"type": "object",
-						"properties": {
-							"@container": {
-								"type": "string",
-								"const": "@set"
-							},
-							"@protected": {
-								"type": "boolean"
-							}
-						},
-						"required": [
-							"@container"
-						],
-						"additionalProperties": false
-					},
-					"@version": {
-						"type": "string",
-						"const": "1.1"
-					},
-					"@vocab": {
-						"type": [
-							"string",
-							"null"
-						]
-					}
-				},
-				"additionalProperties": {
-					"anyOf": [
-						{
-							"type": "null"
-						},
-						{
-							"type": "string"
-						},
-						{
-							"$ref": "#/components/schemas/JsonLdExpandedTermDefinition"
-						}
-					]
-				},
-				"description": "A context definition defines a local context in a node object."
-			},
-			"JsonLdContextDefinitionElement": {
-				"anyOf": [
-					{
-						"type": "null"
-					},
-					{
-						"type": "string"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdContextDefinition"
-					}
-				],
-				"description": "A context definition element is used to define the types of a context definition."
-			},
-			"JsonLdContextDefinitionRoot": {
-				"anyOf": [
-					{
-						"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
-					},
-					{
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
-						}
-					}
-				],
-				"description": "A context definition root is used to define the root of a context definition."
-			},
-			"JsonLdExpandedTermDefinition": {
-				"anyOf": [
-					{
-						"type": "object",
-						"additionalProperties": false,
-						"properties": {
-							"@id": {
-								"anyOf": [
-									{
-										"type": "string"
-									},
-									{
-										"type": "array",
-										"items": {
-											"type": "string"
-										}
-									},
-									{
-										"type": "null"
-									}
-								]
-							},
-							"@nest": {
-								"type": "string"
-							},
-							"@container": {
-								"anyOf": [
-									{
-										"type": "string",
-										"const": "@list"
-									},
-									{
-										"type": "string",
-										"const": "@set"
-									},
-									{
-										"$ref": "#/components/schemas/JsonLdContainerType"
-									},
-									{
-										"type": "array",
-										"items": {
-											"anyOf": [
-												{
-													"type": "string",
-													"const": "@list"
-												},
-												{
-													"type": "string",
-													"const": "@set"
-												},
-												{
-													"$ref": "#/components/schemas/JsonLdContainerType"
-												}
-											]
-										}
-									},
-									{
-										"$ref": "#/components/schemas/JsonLdContainerTypeArray"
-									},
-									{
-										"type": "null"
-									}
-								]
-							},
-							"@type": {
-								"type": "string"
-							},
-							"@language": {
-								"type": "string"
-							},
-							"@index": {
-								"type": "string"
-							},
-							"@context": {
-								"$ref": "#/components/schemas/JsonLdContextDefinition"
-							},
-							"@prefix": {
-								"type": "boolean"
-							},
-							"@propagate": {
-								"type": "boolean"
-							},
-							"@protected": {
-								"type": "boolean"
-							}
-						}
-					},
-					{
-						"type": "object",
-						"additionalProperties": false,
-						"properties": {
-							"@reverse": {
-								"type": "string"
-							},
-							"@container": {
-								"type": [
-									"string",
-									"null"
-								],
-								"enum": [
-									"@set",
-									"@index",
-									null
-								]
-							},
-							"@type": {
-								"type": "string"
-							},
-							"@language": {
-								"type": "string"
-							},
-							"@index": {
-								"type": "string"
-							},
-							"@context": {
-								"$ref": "#/components/schemas/JsonLdContextDefinition"
-							},
-							"@prefix": {
-								"type": "boolean"
-							},
-							"@propagate": {
-								"type": "boolean"
-							},
-							"@protected": {
-								"type": "boolean"
-							}
-						},
-						"required": [
-							"@reverse"
-						]
-					}
-				],
-				"description": "An expanded term definition is used to describe the mapping between a term and its expanded identifier, as well as other properties of the value associated with the term when it is used as key in a node object."
-			},
-			"JsonLdGraphObject": {
-				"type": "object",
-				"properties": {
-					"@graph": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/JsonLdNodeObject"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "#/components/schemas/JsonLdNodeObject"
-								}
-							}
-						]
-					},
-					"@index": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					},
-					"@id": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					},
-					"@context": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					}
-				},
-				"required": [
-					"@graph"
-				],
-				"additionalProperties": false,
-				"description": "A graph object represents a named graph, which MAY include an explicit graph name."
-			},
-			"JsonLdIdMap": {
-				"type": "object",
-				"additionalProperties": {
-					"$ref": "#/components/schemas/JsonLdNodeObject"
-				},
-				"description": "An id map is used to associate an IRI with a value that allows easy programmatic access."
-			},
-			"JsonLdIncludedBlock": {
-				"anyOf": [
-					{
-						"$ref": "#/components/schemas/JsonLdNodeObject"
-					},
-					{
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schemas/JsonLdNodeObject"
-						}
-					}
-				],
-				"description": "An included block is used to provide a set of node objects."
-			},
-			"JsonLdIndexMap": {
-				"type": "object",
-				"additionalProperties": {
-					"anyOf": [
-						{
-							"$ref": "#/components/schemas/JsonLdIndexMapItem"
-						},
-						{
-							"type": "array",
-							"items": {
-								"$ref": "#/components/schemas/JsonLdIndexMapItem"
-							}
-						}
-					]
-				},
-				"description": "An index map allows keys that have no semantic meaning, but should be preserved regardless, to be used in JSON-LD documents."
-			},
-			"JsonLdIndexMapItem": {
-				"anyOf": [
-					{
-						"type": "null"
-					},
-					{
-						"type": "boolean"
-					},
-					{
-						"type": "number"
-					},
-					{
-						"type": "string"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdNodeObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdValueObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdListObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdSetObject"
-					}
-				],
-				"description": "The items that can be stored in an index map."
-			},
-			"JsonLdJsonArray": {
-				"type": "array",
-				"items": {
-					"$ref": "#/components/schemas/JsonLdJsonValue"
-				},
-				"description": "JSON Type for array."
-			},
-			"JsonLdJsonObject": {
-				"type": "object",
-				"additionalProperties": {
-					"anyOf": [
-						{
-							"$ref": "#/components/schemas/JsonLdJsonValue"
-						},
-						{
-							"not": {}
-						}
-					]
-				},
-				"description": "JSON Type for object."
-			},
-			"JsonLdJsonPrimitive": {
-				"type": [
-					"string",
-					"number",
-					"boolean",
-					"null"
-				],
-				"description": "JSON Primitive."
-			},
-			"JsonLdJsonValue": {
-				"anyOf": [
-					{
-						"$ref": "#/components/schemas/JsonLdJsonPrimitive"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdJsonArray"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdJsonObject"
-					}
-				],
-				"description": "JSON Value."
-			},
-			"JsonLdKeyword": {
-				"type": "object",
-				"properties": {
-					"@base": {
-						"type": [
-							"string",
-							"null"
-						]
-					},
-					"@container": {
-						"anyOf": [
-							{
-								"type": "string",
-								"const": "@list"
-							},
-							{
-								"type": "string",
-								"const": "@set"
-							},
-							{
-								"$ref": "#/components/schemas/JsonLdContainerType"
-							},
-							{
-								"type": "array",
-								"items": {
-									"anyOf": [
-										{
-											"type": "string",
-											"const": "@list"
-										},
-										{
-											"type": "string",
-											"const": "@set"
-										},
-										{
-											"$ref": "#/components/schemas/JsonLdContainerType"
-										}
-									]
-								}
-							},
-							{
-								"$ref": "#/components/schemas/JsonLdContainerTypeArray"
-							},
-							{
-								"type": "null"
-							}
-						]
-					},
-					"@context": {
-						"$ref": "#/components/schemas/JsonLdContextDefinitionRoot"
-					},
-					"@direction": {
-						"type": [
-							"string",
-							"null"
-						],
-						"enum": [
-							"ltr",
-							"rtl",
-							null
-						]
-					},
-					"@graph": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/JsonLdValueObject"
-							},
-							{
-								"$ref": "#/components/schemas/JsonLdNodeObject"
-							},
-							{
-								"type": "array",
-								"items": {
-									"anyOf": [
-										{
-											"$ref": "#/components/schemas/JsonLdValueObject"
-										},
-										{
-											"$ref": "#/components/schemas/JsonLdNodeObject"
-										}
-									]
-								}
-							}
-						]
-					},
-					"@id": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"type": "array",
-								"items": {
-									"type": "string"
-								}
-							}
-						]
-					},
-					"@import": {
-						"type": "string"
-					},
-					"@included": {
-						"$ref": "#/components/schemas/JsonLdIncludedBlock"
-					},
-					"@index": {
-						"type": "string"
-					},
-					"@json": {
-						"type": "string",
-						"const": "@json"
-					},
-					"@language": {
-						"type": "string"
-					},
-					"@list": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/JsonLdListOrSetItem"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "#/components/schemas/JsonLdListOrSetItem"
-								}
-							}
-						]
-					},
-					"@nest": {
-						"type": "object"
-					},
-					"@none": {
-						"type": "string",
-						"const": "@none"
-					},
-					"@prefix": {
-						"type": "boolean"
-					},
-					"@propagate": {
-						"type": "boolean"
-					},
-					"@protected": {
-						"type": "boolean"
-					},
-					"@reverse": {
-						"type": "string"
-					},
-					"@set": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/JsonLdListOrSetItem"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "#/components/schemas/JsonLdListOrSetItem"
-								}
-							}
-						]
-					},
-					"@type": {
-						"type": "string"
-					},
-					"@value": {
-						"type": [
-							"null",
-							"boolean",
-							"number",
-							"string"
-						]
-					},
-					"@version": {
-						"type": "string",
-						"const": "1.1"
-					},
-					"@vocab": {
-						"type": [
-							"string",
-							"null"
-						]
-					}
-				},
-				"required": [
-					"@base",
-					"@container",
-					"@context",
-					"@direction",
-					"@graph",
-					"@id",
-					"@import",
-					"@included",
-					"@index",
-					"@json",
-					"@language",
-					"@list",
-					"@nest",
-					"@none",
-					"@prefix",
-					"@propagate",
-					"@protected",
-					"@reverse",
-					"@set",
-					"@type",
-					"@value",
-					"@version",
-					"@vocab"
-				],
-				"additionalProperties": false,
-				"description": "A list of keywords and their types. Only used for internal reference; not an actual interface. Not for export."
-			},
-			"JsonLdLanguageMap": {
-				"type": "object",
-				"additionalProperties": {
-					"anyOf": [
-						{
-							"type": "null"
-						},
-						{
-							"type": "string"
-						},
-						{
-							"type": "array",
-							"items": {
-								"type": "string"
-							}
-						}
-					]
-				},
-				"description": "A language map is used to associate a language with a value in a way that allows easy programmatic access."
-			},
-			"JsonLdListObject": {
-				"type": "object",
-				"properties": {
-					"@list": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					},
-					"@index": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					}
-				},
-				"required": [
-					"@list"
-				],
-				"additionalProperties": false,
-				"description": "A list represents an ordered set of values."
-			},
-			"JsonLdListOrSetItem": {
-				"anyOf": [
-					{
-						"type": "null"
-					},
-					{
-						"type": "boolean"
-					},
-					{
-						"type": "number"
-					},
-					{
-						"type": "string"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdNodeObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdValueObject"
-					}
-				],
-				"description": "A list or set item can be a null, boolean, number, string, node object, or value object."
-			},
-			"JsonLdNodeObject": {
-				"type": "object",
-				"additionalProperties": {
-					"anyOf": [
-						{
-							"$ref": "#/components/schemas/JsonLdNodePrimitive"
-						},
-						{
-							"$ref": "#/components/schemas/JsonLdLanguageMap"
-						},
-						{
-							"$ref": "#/components/schemas/JsonLdIndexMap"
-						},
-						{
-							"$ref": "#/components/schemas/JsonLdIncludedBlock"
-						},
-						{
-							"$ref": "#/components/schemas/JsonLdIdMap"
-						},
-						{
-							"$ref": "#/components/schemas/JsonLdTypeMap"
-						},
-						{
-							"type": "array"
-						}
-					]
-				},
-				"properties": {
-					"@context": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					},
-					"@id": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					},
-					"@included": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					},
-					"@graph": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/JsonLdNodeObject"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "#/components/schemas/JsonLdNodeObject"
-								}
-							}
-						]
-					},
-					"@nest": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/JsonLdJsonObject"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "#/components/schemas/JsonLdJsonObject"
-								}
-							}
-						]
-					},
-					"@type": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							{
-								"type": "array",
-								"items": {
-									"$ref": "#/components/schemas/JsonLdKeyword"
-								}
-							}
-						]
-					},
-					"@reverse": {
-						"type": "object",
-						"additionalProperties": {
-							"$ref": "#/components/schemas/JsonLdKeyword"
-						}
-					},
-					"@index": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					}
-				},
-				"description": "A node object represents zero or more properties of a node in the graph serialized by the JSON-LD document."
-			},
-			"JsonLdNodePrimitive": {
-				"anyOf": [
-					{
-						"type": "null"
-					},
-					{
-						"type": "boolean"
-					},
-					{
-						"type": "number"
-					},
-					{
-						"type": "string"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdNodeObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdGraphObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdValueObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdListObject"
-					},
-					{
-						"$ref": "#/components/schemas/JsonLdSetObject"
-					}
-				],
-				"description": "A node primitive is a JSON-LD value which is not one of the defined NodeObject properties."
-			},
-			"JsonLdSetObject": {
-				"type": "object",
-				"properties": {
-					"@set": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					},
-					"@index": {
-						"$ref": "#/components/schemas/JsonLdKeyword"
-					}
-				},
-				"required": [
-					"@set"
-				],
-				"additionalProperties": false,
-				"description": "A set represents an unordered set of values."
-			},
-			"JsonLdTypeMap": {
-				"type": "object",
-				"additionalProperties": {
-					"anyOf": [
-						{
-							"type": "string"
-						},
-						{
-							"$ref": "#/components/schemas/JsonLdNodeObject"
-						}
-					]
-				},
-				"description": "A type map is used to associate an IRI with a value that allows easy programmatic access."
-			},
-			"JsonLdValueObject": {
-				"anyOf": [
-					{
-						"type": "object",
-						"additionalProperties": false,
-						"properties": {
-							"@value": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@language": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@direction": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@index": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@context": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							}
-						},
-						"required": [
-							"@value"
-						]
-					},
-					{
-						"type": "object",
-						"additionalProperties": false,
-						"properties": {
-							"@value": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@type": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@index": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@context": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							}
-						},
-						"required": [
-							"@type",
-							"@value"
-						]
-					},
-					{
-						"type": "object",
-						"additionalProperties": false,
-						"properties": {
-							"@value": {
-								"anyOf": [
-									{
-										"$ref": "#/components/schemas/JsonLdKeyword"
-									},
-									{
-										"$ref": "#/components/schemas/JsonLdJsonObject"
-									},
-									{
-										"$ref": "#/components/schemas/JsonLdJsonArray"
-									}
-								]
-							},
-							"@type": {
-								"type": "string",
-								"const": "@json"
-							},
-							"@index": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							},
-							"@context": {
-								"$ref": "#/components/schemas/JsonLdKeyword"
-							}
-						},
-						"required": [
-							"@type",
-							"@value"
-						]
-					}
-				],
-				"description": "A value object is used to explicitly associate a type or a language with a value to create a typed value or a language-tagged string and possibly associate a base direction."
-			},
 			"NotFoundResponse": {
 				"type": "object",
 				"additionalProperties": false,