@3sixty/document-management-service 0.0.0-stage → 0.20.0-next.0

package/docs/open-api/spec.json

@@ -0,0 +1,1387 @@
+{
+	"openapi": "3.1.1",
+	"info": {
+		"title": "3Sixty - Test Endpoints",
+		"description": "REST API for 3Sixty - Test Endpoints.",
+		"version": "1.0.0",
+		"license": {
+			"name": "Apache 2.0 License",
+			"url": "https://opensource.org/licenses/Apache-2.0"
+		}
+	},
+	"servers": [
+		{
+			"url": "https://localhost"
+		}
+	],
+	"tags": [
+		{
+			"name": "Document Management",
+			"description": "Endpoints which are modelled to access a document management contract."
+		}
+	],
+	"paths": {
+		"/document-management": {
+			"post": {
+				"operationId": "DocumentManagementSet",
+				"summary": "Store a document in an auditable item graph vertex and add its content to blob storage.",
+				"tags": [
+					"Document Management"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Request to create a document as an auditable item graph vertex.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/DocumentManagementCreateRequest"
+							},
+							"examples": {
+								"DocumentManagementCreateRequestExample": {
+									"value": {
+										"document": {
+											"documentId": "2721000",
+											"documentIdFormat": "bol",
+											"documentCode": "unece:DocumentCodeList#705",
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											}
+										},
+										"blob": "SGVsbG8gV29ybGQ=",
+										"options": {
+											"includeAttestation": true
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"201": {
+						"description": "The rest request ended in created response.",
+						"headers": {
+							"location": {
+								"schema": {
+									"type": "string"
+								},
+								"description": "e.g. aig%3A123456"
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"get": {
+				"operationId": "DocumentManagementQuery",
+				"summary": "Query the items from an auditable item graph vertex",
+				"tags": [
+					"Document Management"
+				],
+				"parameters": [
+					{
+						"name": "documentId",
+						"description": "The id of the document id we are trying to find.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "2721000"
+					},
+					{
+						"name": "cursor",
+						"description": "The cursor to get the next chunk of documents.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "The number of documents to return.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to query the documents from an auditable item graph vertex.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.3sixty.global/aig/AuditableItemGraphVertexList"
+								},
+								"examples": {
+									"DocumentManagementQueryResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.3sixty.global/aig/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemGraphVertexList"
+											],
+											"itemListElement": [
+												{
+													"@context": [
+														"https://schema.3sixty.global/aig/",
+														"https://schema.3sixty.global/common/"
+													],
+													"id": "aig:c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7",
+													"type": "AuditableItemGraphVertex",
+													"dateCreated": "2024-08-22T04:13:20.000Z",
+													"aliases": [
+														{
+															"@context": [
+																"https://schema.3sixty.global/aig/"
+															],
+															"id": "test-id-0",
+															"type": "AuditableItemGraphAlias",
+															"dateCreated": "2024-08-22T04:13:20.000Z"
+														}
+													],
+													"resources": [
+														{
+															"@context": "https://schema.3sixty.global/aig/",
+															"type": "AuditableItemGraphResource",
+															"dateCreated": "2024-08-22T04:13:20.000Z",
+															"resourceObject": {
+																"@context": [
+																	"https://schema.3sixty.global/documents/",
+																	"https://schema.3sixty.global/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"
+																},
+																"integrity": "sha256-E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
+																"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
+																"dateCreated": "2024-08-22T04:13:20.000Z",
+																"organizationIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
+																"userIdentity": "did:entity-storage:0x0404040404040404040404040404040404040404040404040404040404040404"
+															}
+														}
+													]
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/document-management/{auditableItemGraphDocumentId}": {
+			"patch": {
+				"operationId": "DocumentManagementUpdatePartial",
+				"summary": "Partially update a document in an auditable item graph vertex and add its content to blob storage.",
+				"tags": [
+					"Document Management"
+				],
+				"parameters": [
+					{
+						"name": "auditableItemGraphDocumentId",
+						"description": "The full id of the document to update.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:123456"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Request to partially update a document as an auditable item graph vertex.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/DocumentManagementUpdatePartialRequest"
+							},
+							"examples": {
+								"DocumentManagementUpdatePartialRequestExample": {
+									"value": {
+										"document": {
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											}
+										},
+										"blob": "SGVsbG8gV29ybGQ="
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"get": {
+				"operationId": "DocumentManagementGet",
+				"summary": "Get the data for a document from document management",
+				"tags": [
+					"Document Management"
+				],
+				"parameters": [
+					{
+						"name": "auditableItemGraphDocumentId",
+						"description": "The full id of the document to get.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:123456"
+					},
+					{
+						"name": "includeBlobStorageMetadata",
+						"description": "Include the blob storage metadata in the response.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "includeBlobStorageData",
+						"description": "Include the blob storage data in the response.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "includeAttestation",
+						"description": "Include the attestation information in the response.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "includeRemoved",
+						"description": "Include deleted documents in the response.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "includeDeletedEdges",
+						"description": "Include soft-deleted edges in the response.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "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"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "Limit the number of items to return, defaults to 1 so only most recent is returned.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "cursor",
+						"description": "The cursor to get the next chunk of revisions.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to get a document and optionally revisions from an auditable item graph vertex.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/DocumentList"
+								},
+								"examples": {
+									"DocumentManagementGetResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.3sixty.global/documents/",
+												"https://schema.3sixty.global/common/"
+											],
+											"type": "ItemList",
+											"itemListElement": [
+												{
+													"@context": [
+														"https://schema.org",
+														"https://schema.3sixty.global/documents/",
+														"https://schema.3sixty.global/common/"
+													],
+													"type": "Document",
+													"id": "2721000:0",
+													"documentId": "2721000",
+													"documentIdFormat": "bol",
+													"documentCode": "unece:DocumentCodeList#705",
+													"documentRevision": 0,
+													"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+													"integrity": "sha256-123456",
+													"dateCreated": "2024-01-01T00:00:00Z",
+													"annotationObject": {
+														"@context": "https://schema.org",
+														"@type": "DigitalDocument",
+														"name": "myfile.pdf"
+													},
+													"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+												}
+											]
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "#/components/schemas/DocumentList"
+								},
+								"examples": {
+									"DocumentManagementGetResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.3sixty.global/documents/",
+												"https://schema.3sixty.global/common/"
+											],
+											"type": "ItemList",
+											"itemListElement": [
+												{
+													"@context": [
+														"https://schema.org",
+														"https://schema.3sixty.global/documents/",
+														"https://schema.3sixty.global/common/"
+													],
+													"type": "Document",
+													"id": "2721000:0",
+													"documentId": "2721000",
+													"documentIdFormat": "bol",
+													"documentCode": "unece:DocumentCodeList#705",
+													"documentRevision": 0,
+													"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+													"integrity": "sha256-123456",
+													"dateCreated": "2024-01-01T00:00:00Z",
+													"annotationObject": {
+														"@context": "https://schema.org",
+														"@type": "DigitalDocument",
+														"name": "myfile.pdf"
+													},
+													"organizationIdentity": "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": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "The resource you tried to access does not exist, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/NotFoundResponse"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "NotFoundError",
+											"message": "errorMessage",
+											"properties": {
+												"notFoundId": "1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/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.org",
+												"https://schema.3sixty.global/documents/",
+												"https://schema.3sixty.global/common/"
+											],
+											"type": "Document",
+											"id": "2721000:0",
+											"documentId": "2721000",
+											"documentIdFormat": "bol",
+											"documentCode": "unece:DocumentCodeList#705",
+											"documentRevision": 1,
+											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+											"integrity": "sha256-123456",
+											"dateCreated": "2024-01-01T00:00:00Z",
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											},
+											"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "#/components/schemas/Document"
+								},
+								"examples": {
+									"DocumentManagementGetRevisionResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.3sixty.global/documents/",
+												"https://schema.3sixty.global/common/"
+											],
+											"type": "Document",
+											"id": "2721000:0",
+											"documentId": "2721000",
+											"documentIdFormat": "bol",
+											"documentCode": "unece:DocumentCodeList#705",
+											"documentRevision": 1,
+											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+											"integrity": "sha256-123456",
+											"dateCreated": "2024-01-01T00:00:00Z",
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											},
+											"organizationIdentity": "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": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "The resource you tried to access does not exist, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/NotFoundResponse"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "NotFoundError",
+											"message": "errorMessage",
+											"properties": {
+												"notFoundId": "1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"delete": {
+				"operationId": "DocumentManagementRemove",
+				"summary": "Remove an document from an auditable item graph vertex",
+				"tags": [
+					"Document Management"
+				],
+				"parameters": [
+					{
+						"name": "auditableItemGraphDocumentId",
+						"description": "The id of the auditable item graph vertex to remove the revision from.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:1234"
+					},
+					{
+						"name": "revision",
+						"description": "The revision of the document to remove.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "1"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "The resource you tried to access does not exist, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/NotFoundResponse"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "NotFoundError",
+											"message": "errorMessage",
+											"properties": {
+												"notFoundId": "1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"components": {
+		"schemas": {
+			"Document": {
+				"description": "Interface describing a document.",
+				"type": "object",
+				"properties": {
+					"@context": {
+						"type": "array",
+						"prefixItems": [
+							{
+								"const": "https://schema.org"
+							},
+							{
+								"const": "https://schema.3sixty.global/documents/"
+							},
+							{
+								"const": "https://schema.3sixty.global/common/"
+							}
+						],
+						"items": {
+							"$ref": "https://schema.3sixty.global/json-ld/JsonLdContextDefinitionElement"
+						},
+						"minItems": 3,
+						"description": "JSON-LD Context."
+					},
+					"type": {
+						"const": "Document",
+						"description": "JSON-LD Type."
+					},
+					"id": {
+						"type": "string",
+						"description": "The full id of the document."
+					},
+					"documentRevision": {
+						"type": "number",
+						"description": "The revision of the document as a 0 based index."
+					},
+					"blobStorageId": {
+						"type": "string",
+						"description": "The blob storage id for the document."
+					},
+					"integrity": {
+						"type": "string",
+						"description": "The integrity of the blob data."
+					},
+					"attestationId": {
+						"type": "string",
+						"description": "The attestation for the document if one was created."
+					},
+					"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."
+					},
+					"organizationIdentity": {
+						"type": "string",
+						"description": "The organization which added the document to the graph."
+					},
+					"userIdentity": {
+						"type": "string",
+						"description": "The user who added the document to the graph."
+					}
+				},
+				"required": [
+					"@context",
+					"type",
+					"id",
+					"documentRevision",
+					"blobStorageId",
+					"integrity",
+					"dateCreated"
+				],
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/DocumentBase"
+					}
+				]
+			},
+			"DocumentBase": {
+				"description": "Interface describing a document base.",
+				"type": "object",
+				"properties": {
+					"documentId": {
+						"type": "string",
+						"description": "The id of the document."
+					},
+					"documentIdFormat": {
+						"type": "string",
+						"description": "The format of the document id."
+					},
+					"documentCode": {
+						"$ref": "https://schema.3sixty.global/unece/UneceDocumentCodeList"
+					},
+					"annotationObject": {
+						"$ref": "https://schema.3sixty.global/json-ld/JsonLdNodeObject"
+					}
+				},
+				"required": [
+					"documentId",
+					"documentCode"
+				]
+			},
+			"DocumentHydrated": {
+				"description": "Interface describing a hydrated document which includes additional information that can be optionally requested when retrieving a document.",
+				"type": "object",
+				"properties": {
+					"blobStorageEntry": {
+						"$ref": "https://schema.3sixty.global/blob-storage/BlobStorageEntry"
+					},
+					"extractedData": {
+						"description": "The data extracted from the document using data extraction services."
+					},
+					"attestationInformation": {
+						"$ref": "https://schema.3sixty.global/attestation/AttestationInformation"
+					}
+				},
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Document"
+					}
+				]
+			},
+			"DocumentList": {
+				"description": "Interface describing a list of document entries.",
+				"type": "object",
+				"properties": {
+					"@context": {
+						"type": "array",
+						"prefixItems": [
+							{
+								"const": "https://schema.org"
+							},
+							{
+								"const": "https://schema.3sixty.global/documents/"
+							},
+							{
+								"const": "https://schema.3sixty.global/common/"
+							}
+						],
+						"items": {
+							"$ref": "https://schema.3sixty.global/json-ld/JsonLdContextDefinitionElement"
+						},
+						"minItems": 3,
+						"description": "JSON-LD Context."
+					},
+					"type": {
+						"const": "ItemList",
+						"description": "JSON-LD Type."
+					},
+					"itemListElement": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/DocumentHydrated"
+						},
+						"description": "The list of documents."
+					},
+					"edges": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						},
+						"description": "The ids of the other vertices which are connected to the document."
+					}
+				},
+				"required": [
+					"@context",
+					"type",
+					"itemListElement"
+				]
+			},
+			"DocumentManagementCreateRequest": {
+				"type": "object",
+				"properties": {
+					"document": {
+						"$ref": "#/components/schemas/DocumentBase"
+					},
+					"blob": {
+						"type": "string",
+						"description": "The data to create the document with, either as base64-encoded content or an existing blob storage entry id."
+					},
+					"auditableItemGraphEdges": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/DocumentManagementEdgeEntry"
+						},
+						"description": "The auditable item graph vertices to connect the document to."
+					},
+					"options": {
+						"type": "object",
+						"properties": {
+							"includeAttestation": {
+								"type": "boolean",
+								"description": "Flag to create an attestation for the document, defaults to false."
+							},
+							"includeAlias": {
+								"type": "boolean",
+								"description": "Flag to add the document id as an alias to the aig vertex, defaults to true."
+							},
+							"aliasAnnotationObject": {
+								"$ref": "https://schema.3sixty.global/json-ld/JsonLdNodeObject"
+							}
+						},
+						"description": "Additional options for the create operation."
+					}
+				},
+				"required": [
+					"document",
+					"blob"
+				],
+				"description": "The body parameters."
+			},
+			"DocumentManagementEdgeEntry": {
+				"description": "A single edge entry used when connecting a document to an AIG vertex.",
+				"type": "object",
+				"properties": {
+					"targetId": {
+						"type": "string",
+						"description": "The target AIG vertex id to connect to."
+					},
+					"includeAlias": {
+						"type": "boolean",
+						"description": "Whether to add the document id as an alias on the connected vertex, defaults to false."
+					},
+					"aliasAnnotationObject": {
+						"$ref": "https://schema.3sixty.global/json-ld/JsonLdNodeObject"
+					}
+				},
+				"required": [
+					"targetId"
+				]
+			},
+			"DocumentManagementUpdatePartialRequest": {
+				"type": "object",
+				"properties": {
+					"document": {
+						"description": "The document base properties to update. annotationObject, documentIdFormat and documentCode are applied in-place to the current revision.",
+						"type": "object",
+						"properties": {
+							"documentIdFormat": {
+								"type": "string",
+								"description": "The format of the document id."
+							},
+							"documentCode": {
+								"$ref": "https://schema.3sixty.global/unece/UneceDocumentCodeList"
+							},
+							"annotationObject": {
+								"$ref": "https://schema.3sixty.global/json-ld/JsonLdNodeObject"
+							}
+						}
+					},
+					"blob": {
+						"type": "string",
+						"description": "The data to update the document with, either as base64-encoded content or an existing blob storage entry id."
+					},
+					"auditableItemGraphEdges": {
+						"type": "object",
+						"properties": {
+							"add": {
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DocumentManagementEdgeEntry"
+								},
+								"description": "Connections to add; each entry creates a back-edge on the connected vertex."
+							},
+							"remove": {
+								"type": "array",
+								"items": {
+									"type": "string"
+								},
+								"description": "Target vertex IDs to disconnect; their back-edges are removed."
+							}
+						},
+						"description": "Explicit edge delta to apply. Use `add` to create new connections and `remove` to\ndisconnect existing ones by their target vertex id."
+					},
+					"options": {
+						"type": "object",
+						"properties": {
+							"includeAttestation": {
+								"type": "boolean",
+								"description": "Set to true to start attesting the document (even if originally created without attestation), or false to remove the existing attestation. Omit to leave attestation state unchanged."
+							},
+							"includeAlias": {
+								"type": "boolean",
+								"description": "Set to true to add the document id as an alias on the aig vertex, or false to remove it. Omit to leave alias state unchanged."
+							},
+							"aliasAnnotationObject": {
+								"$ref": "https://schema.3sixty.global/json-ld/JsonLdNodeObject"
+							}
+						},
+						"description": "Additional options for the update operation."
+					}
+				},
+				"description": "The body parameters."
+			},
+			"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"
+				]
+			},
+			"NotFoundResponse": {
+				"type": "object",
+				"properties": {
+					"notFoundId": {
+						"type": "string",
+						"description": "The id if the item that was not found."
+					}
+				},
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Error"
+					}
+				],
+				"description": "The body which contains the error."
+			}
+		},
+		"securitySchemes": {
+			"jwtBearerAuthScheme": {
+				"type": "http",
+				"scheme": "bearer",
+				"bearerFormat": "JWT"
+			}
+		}
+	}
+}