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

package/docs/open-api/spec.json

@@ -39,26 +39,36 @@
 					"content": {
 						"application/json": {
 							"schema": {
-								"$ref": "#/components/schemas/AuditableItemStreamCreateRequest"
+								"$ref": "https://schema.twindev.org/ais/AuditableItemStreamBase"
 							},
 							"examples": {
 								"auditableItemStreamCreateRequestExample": {
 									"value": {
+										"@context": [
+											"https://schema.org",
+											"https://schema.twindev.org/ais/",
+											"https://schema.twindev.org/common/"
+										],
+										"type": "AuditableItemStream",
 										"annotationObject": {
 											"@context": "https://schema.org",
 											"@type": "Note",
 											"content": "This is a simple note"
 										},
-										"entries": [
-											{
-												"entryObject": {
-													"@context": "https://schema.org",
-													"@type": "Event",
-													"startDate": "2011-04-09T20:00:00Z",
-													"description": "A description of the event"
+										"entries": {
+											"type": "ItemList",
+											"itemListElement": [
+												{
+													"type": "AuditableItemStreamEntry",
+													"entryObject": {
+														"@context": "https://schema.org",
+														"@type": "Event",
+														"startDate": "2011-04-09T20:00:00Z",
+														"description": "A description of the event"
+													}
 												}
-											}
-										]
+											]
+										}
 									}
 								}
 							}
@@ -73,7 +83,7 @@
 								"schema": {
 									"type": "string"
 								},
-								"description": "e.g. ais:1234567890"
+								"description": "e.g. ais%3A1234567890"
 							}
 						}
 					},
@@ -158,7 +168,6 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "string",
 							"enum": [
 								"dateCreated",
 								"dateModified"
@@ -239,6 +248,7 @@
 											"itemListElement": [
 												{
 													"@context": [
+														"https://schema.org",
 														"https://schema.twindev.org/ais/",
 														"https://schema.twindev.org/common/"
 													],
@@ -253,10 +263,10 @@
 													},
 													"organizationIdentity": "did:iota:1234567890",
 													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
-													"immutableInterval": 10
+													"immutableInterval": 10,
+													"numberOfItems": 0
 												}
-											],
-											"nextItem": "1"
+											]
 										}
 									}
 								}
@@ -280,6 +290,7 @@
 											"itemListElement": [
 												{
 													"@context": [
+														"https://schema.org",
 														"https://schema.twindev.org/ais/",
 														"https://schema.twindev.org/common/"
 													],
@@ -294,10 +305,10 @@
 													},
 													"organizationIdentity": "did:iota:1234567890",
 													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
-													"immutableInterval": 10
+													"immutableInterval": 10,
+													"numberOfItems": 0
 												}
-											],
-											"nextItem": "1"
+											]
 										}
 									}
 								}
@@ -412,9 +423,27 @@
 						"style": "simple",
 						"example": "ais:1234567890"
 					},
+					{
+						"name": "cursor",
+						"description": "Cursor to use for next chunk of entries.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "Limit the number of entries to return, only applicable if includeEntries is true.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
 					{
 						"name": "includeEntries",
-						"description": "Whether to include the entries, defaults to false. The entries will be limited to the first page of entries in date descending order. If you want to get more entries you can use the returned cursor with the get entries method.",
+						"description": "Whether to include the entries, defaults to false.\nThe entries will be limited to the first page of entries in date descending order.\nIf you want to get more entries you can use the returned cursor with the get entries method.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -476,6 +505,7 @@
 									"auditableItemStreamGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://schema.org",
 												"https://schema.twindev.org/ais/",
 												"https://schema.twindev.org/common/"
 											],
@@ -491,25 +521,29 @@
 											"organizationIdentity": "did:iota:1234567890",
 											"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
 											"immutableInterval": 10,
-											"entries": [
-												{
-													"@context": [
-														"https://schema.twindev.org/ais/",
-														"https://schema.twindev.org/common/"
-													],
-													"type": "AuditableItemStreamEntry",
-													"id": "tst:1234567890",
-													"dateCreated": "2024-08-22T11:55:16.271Z",
-													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
-													"index": 0,
-													"entryObject": {
-														"@context": "https://schema.org",
-														"@type": "Event",
-														"startDate": "2011-04-09T20:00:00Z",
-														"description": "A description of the event"
+											"numberOfItems": 1,
+											"entries": {
+												"type": "ItemList",
+												"itemListElement": [
+													{
+														"@context": [
+															"https://schema.twindev.org/ais/",
+															"https://schema.twindev.org/common/"
+														],
+														"type": "AuditableItemStreamEntry",
+														"id": "tst:1234567890",
+														"dateCreated": "2024-08-22T11:55:16.271Z",
+														"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
+														"index": 0,
+														"entryObject": {
+															"@context": "https://schema.org",
+															"@type": "Event",
+															"startDate": "2011-04-09T20:00:00Z",
+															"description": "A description of the event"
+														}
 													}
-												}
-											]
+												]
+											}
 										}
 									}
 								}
@@ -522,6 +556,7 @@
 									"auditableItemStreamJsonLdGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://schema.org",
 												"https://schema.twindev.org/ais/",
 												"https://schema.twindev.org/common/"
 											],
@@ -537,25 +572,29 @@
 											"organizationIdentity": "did:iota:1234567890",
 											"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
 											"immutableInterval": 10,
-											"entries": [
-												{
-													"@context": [
-														"https://schema.twindev.org/ais/",
-														"https://schema.twindev.org/common/"
-													],
-													"type": "AuditableItemStreamEntry",
-													"id": "tst:1234567890",
-													"dateCreated": "2024-08-22T11:55:16.271Z",
-													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
-													"index": 0,
-													"entryObject": {
-														"@context": "https://schema.org",
-														"@type": "Event",
-														"startDate": "2011-04-09T20:00:00Z",
-														"description": "A description of the event"
+											"numberOfItems": 1,
+											"entries": {
+												"type": "ItemList",
+												"itemListElement": [
+													{
+														"@context": [
+															"https://schema.twindev.org/ais/",
+															"https://schema.twindev.org/common/"
+														],
+														"type": "AuditableItemStreamEntry",
+														"id": "tst:1234567890",
+														"dateCreated": "2024-08-22T11:55:16.271Z",
+														"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
+														"index": 0,
+														"entryObject": {
+															"@context": "https://schema.org",
+															"@type": "Event",
+															"startDate": "2011-04-09T20:00:00Z",
+															"description": "A description of the event"
+														}
 													}
-												}
-											]
+												]
+											}
 										}
 									}
 								}
@@ -685,6 +724,12 @@
 							"examples": {
 								"auditableItemStreamUpdateRequestExample": {
 									"value": {
+										"@context": [
+											"https://schema.org",
+											"https://schema.twindev.org/ais/",
+											"https://schema.twindev.org/common/"
+										],
+										"type": "AuditableItemStream",
 										"annotationObject": {
 											"@context": "https://schema.org",
 											"@type": "Note",
@@ -887,7 +932,119 @@
 						}
 					}
 				}
-			},
+			}
+		},
+		"/auditable-item-stream/{id}/close": {
+			"put": {
+				"operationId": "auditableItemStreamClose",
+				"summary": "Close a stream",
+				"tags": [
+					"Auditable Item Stream"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the stream to close.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "ais:1234567890"
+					}
+				],
+				"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/auditable-item-stream/{id}/entries": {
 			"post": {
 				"operationId": "auditableItemStreamCreateEntry",
 				"summary": "Create a new stream entry",
@@ -943,7 +1100,7 @@
 								"schema": {
 									"type": "string"
 								},
-								"description": "e.g. ais:1234567890:01010101010"
+								"description": "e.g. ais%3A1234567890%3A01010101010"
 							}
 						}
 					},
@@ -1005,19 +1162,17 @@
 						}
 					}
 				}
-			}
-		},
-		"/auditable-item-stream/{id}/{entryId}": {
+			},
 			"get": {
-				"operationId": "auditableItemStreamGetEntry",
-				"summary": "Get a stream entry",
+				"operationId": "auditableItemStreamListEntries",
+				"summary": "Get the entry objects in a stream",
 				"tags": [
 					"Auditable Item Stream"
 				],
 				"parameters": [
 					{
 						"name": "id",
-						"description": "The id of the stream to update the get in.",
+						"description": "The id of the stream to get.",
 						"in": "path",
 						"required": true,
 						"schema": {
@@ -1027,19 +1182,53 @@
 						"example": "ais:1234567890"
 					},
 					{
-						"name": "entryId",
-						"description": "The id of the entry to update.",
-						"in": "path",
-						"required": true,
+						"name": "conditions",
+						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"in": "query",
+						"required": false,
 						"schema": {
 							"type": "string"
-						},
-						"style": "simple",
-						"example": "ais:1234567890:01010101010"
+						}
 					},
 					{
-						"name": "verifyEntry",
-						"description": "Verify the entry, defaults to false.",
+						"name": "includeDeleted",
+						"description": "Whether to include deleted entries, defaults to false.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "verifyEntries",
+						"description": "Should the entries be verified, defaults to false.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "order",
+						"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/SortDirection"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "How many entries to return.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "cursor",
+						"description": "Cursor to use for next chunk of data.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -1063,23 +1252,250 @@
 				],
 				"responses": {
 					"200": {
-						"description": "Response to getting an auditable item stream entry.",
+						"description": "Response to getting an auditable item stream entries.",
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntry"
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
 								},
 								"examples": {
-									"auditableItemStreamGetEntryResponseExample": {
+									"auditableItemStreamListEntriesResponseExample": {
 										"value": {
 											"@context": [
+												"https://schema.org",
 												"https://schema.twindev.org/ais/",
 												"https://schema.twindev.org/common/"
 											],
-											"type": "AuditableItemStreamEntry",
-											"id": "tst:1234567890",
-											"dateCreated": "2024-08-22T11:55:16.271Z",
-											"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
+											"type": [
+												"ItemList",
+												"AuditableItemStreamEntryList"
+											],
+											"itemListElement": [
+												{
+													"@context": [
+														"https://schema.twindev.org/ais/",
+														"https://schema.twindev.org/common/"
+													],
+													"type": "AuditableItemStreamEntry",
+													"id": "tst:1234567890",
+													"dateCreated": "2024-08-22T11:55:16.271Z",
+													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
+													"index": 0,
+													"entryObject": {
+														"@context": "https://schema.org",
+														"@type": "Event",
+														"startDate": "2011-04-09T20:00:00Z",
+														"description": "A description of the event"
+													}
+												}
+											]
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
+								},
+								"examples": {
+									"auditableItemStreamJsonLdListEntriesResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/ais/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemStreamEntryList"
+											],
+											"itemListElement": [
+												{
+													"@context": [
+														"https://schema.twindev.org/ais/",
+														"https://schema.twindev.org/common/"
+													],
+													"type": "AuditableItemStreamEntry",
+													"id": "tst:1234567890",
+													"dateCreated": "2024-08-22T11:55:16.271Z",
+													"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
+													"index": 0,
+													"entryObject": {
+														"@context": "https://schema.org",
+														"@type": "Event",
+														"startDate": "2011-04-09T20:00:00Z",
+														"description": "A description of the event"
+													}
+												}
+											]
+										}
+									}
+								}
+							}
+						},
+						"headers": {
+							"content-type": {
+								"schema": {
+									"type": "string"
+								},
+								"description": "e.g. application/ld+json"
+							}
+						}
+					},
+					"400": {
+						"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/auditable-item-stream/{id}/entries/{entryId}": {
+			"get": {
+				"operationId": "auditableItemStreamGetEntry",
+				"summary": "Get a stream entry",
+				"tags": [
+					"Auditable Item Stream"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the stream to update the get in.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "ais:1234567890"
+					},
+					{
+						"name": "entryId",
+						"description": "The id of the entry to update.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "ais:1234567890:01010101010"
+					},
+					{
+						"name": "verifyEntry",
+						"description": "Verify the entry, defaults to false.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting an auditable item stream entry.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntry"
+								},
+								"examples": {
+									"auditableItemStreamGetEntryResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/ais/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": "AuditableItemStreamEntry",
+											"id": "tst:1234567890",
+											"dateCreated": "2024-08-22T11:55:16.271Z",
+											"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
 											"index": 0,
 											"entryObject": {
 												"@context": "https://schema.org",
@@ -1468,10 +1884,10 @@
 				}
 			}
 		},
-		"/auditable-item-stream/{id}/{entryId}/object": {
+		"/auditable-item-stream/{id}/entries/{entryId}/object": {
 			"get": {
 				"operationId": "auditableItemStreamGetEntryObject",
-				"summary": "Get a stream entry",
+				"summary": "Get a stream entry object",
 				"tags": [
 					"Auditable Item Stream"
 				],
@@ -1606,25 +2022,14 @@
 				}
 			}
 		},
-		"/auditable-item-stream/{id}/entries": {
+		"/auditable-item-stream/entries": {
 			"get": {
-				"operationId": "auditableItemStreamListEntries",
-				"summary": "Get the entry objects in a stream",
+				"operationId": "auditableItemStreamListEntriesNoStream",
+				"summary": "Get the entry objects for all streams",
 				"tags": [
 					"Auditable Item Stream"
 				],
 				"parameters": [
-					{
-						"name": "id",
-						"description": "The id of the stream to get.",
-						"in": "path",
-						"required": true,
-						"schema": {
-							"type": "string"
-						},
-						"style": "simple",
-						"example": "ais:1234567890"
-					},
 					{
 						"name": "conditions",
 						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
@@ -1703,7 +2108,7 @@
 									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
 								},
 								"examples": {
-									"auditableItemStreamListEntriesResponseExample": {
+									"auditableItemStreamListEntriesNoStreamResponseExample": {
 										"value": {
 											"@context": [
 												"https://schema.org",
@@ -1732,8 +2137,7 @@
 														"description": "A description of the event"
 													}
 												}
-											],
-											"nextItem": "1"
+											]
 										}
 									}
 								}
@@ -1743,7 +2147,7 @@
 									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
 								},
 								"examples": {
-									"auditableItemStreamJsonLdListEntriesResponseExample": {
+									"auditableItemStreamJsonLdListEntriesNoStreamResponseExample": {
 										"value": {
 											"@context": [
 												"https://schema.org",
@@ -1772,8 +2176,7 @@
 														"description": "A description of the event"
 													}
 												}
-											],
-											"nextItem": "1"
+											]
 										}
 									}
 								}
@@ -1975,8 +2378,7 @@
 													"startDate": "2011-04-09T20:00:00Z",
 													"description": "A description of the event"
 												}
-											],
-											"nextItem": "1"
+											]
 										}
 									}
 								}
@@ -2063,10 +2465,303 @@
 					}
 				}
 			}
-		}
-	},
-	"components": {
-		"schemas": {
+		},
+		"/auditable-item-stream/entries/objects": {
+			"get": {
+				"operationId": "auditableItemStreamListEntryObjectsNoStream",
+				"summary": "Get the entry objects for all streams",
+				"tags": [
+					"Auditable Item Stream"
+				],
+				"parameters": [
+					{
+						"name": "conditions",
+						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "includeDeleted",
+						"description": "Whether to include deleted entries, defaults to false.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "order",
+						"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/SortDirection"
+						}
+					},
+					{
+						"name": "limit",
+						"description": "How many entries to return.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "cursor",
+						"description": "Cursor to use for next chunk of data.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to getting an auditable item stream entries objects.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
+								},
+								"examples": {
+									"auditableItemStreamListEntryObjectsNoStreamResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.org",
+												"https://schema.twindev.org/ais/",
+												"https://schema.twindev.org/common/"
+											],
+											"type": [
+												"ItemList",
+												"AuditableItemStreamEntryObjectList"
+											],
+											"itemListElement": [
+												{
+													"@context": "https://schema.org",
+													"@type": "Event",
+													"startDate": "2011-04-09T20:00:00Z",
+													"description": "A description of the event"
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "The resource you tried to access does not exist, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/NotFoundResponse"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "NotFoundError",
+											"message": "errorMessage",
+											"properties": {
+												"notFoundId": "1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/auditable-item-stream/{id}/proof": {
+			"delete": {
+				"operationId": "auditableItemStreamRemoveProof",
+				"summary": "Remove the proof from a stream",
+				"tags": [
+					"Auditable Item Stream"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the stream to remove the proof from.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "ais:1234567890"
+					}
+				],
+				"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": {
 			"AuditableItemStreamCreateEntryRequest": {
 				"type": "object",
 				"properties": {
@@ -2077,37 +2772,6 @@
 				"required": [
 					"entryObject"
 				],
-				"additionalProperties": false,
-				"description": "The data to be used in the stream."
-			},
-			"AuditableItemStreamCreateRequest": {
-				"type": "object",
-				"properties": {
-					"annotationObject": {
-						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-					},
-					"entries": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"entryObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-								}
-							},
-							"required": [
-								"entryObject"
-							],
-							"additionalProperties": false
-						},
-						"description": "The entries for the stream."
-					},
-					"immutableInterval": {
-						"type": "number",
-						"description": "After how many entries do we add immutable checks, defaults to service configured value. A value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval."
-					}
-				},
-				"additionalProperties": false,
 				"description": "The data to be used in the stream."
 			},
 			"AuditableItemStreamUpdateEntryRequest": {
@@ -2120,20 +2784,46 @@
 				"required": [
 					"entryObject"
 				],
-				"additionalProperties": false,
 				"description": "The data to be used in the entry."
 			},
 			"AuditableItemStreamUpdateRequest": {
+				"description": "The data to be used in the stream, entries should be updated separately.",
 				"type": "object",
 				"properties": {
+					"@context": {
+						"type": "array",
+						"prefixItems": [
+							{
+								"const": "https://schema.org"
+							},
+							{
+								"const": "https://schema.twindev.org/ais/"
+							},
+							{
+								"const": "https://schema.twindev.org/common/"
+							}
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						},
+						"minItems": 3,
+						"description": "JSON-LD Context."
+					},
+					"type": {
+						"const": "AuditableItemStream",
+						"description": "JSON-LD Type."
+					},
 					"annotationObject": {
 						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 					}
 				},
-				"additionalProperties": false,
-				"description": "The data to be used in the stream."
+				"required": [
+					"@context",
+					"type"
+				]
 			},
 			"Error": {
+				"description": "Model to describe serialized error.",
 				"type": "object",
 				"properties": {
 					"name": {
@@ -2142,7 +2832,7 @@
 					},
 					"message": {
 						"type": "string",
-						"description": "The message for the error."
+						"description": "The message for the error as an i18n key."
 					},
 					"source": {
 						"type": "string",
@@ -2164,63 +2854,35 @@
 				"required": [
 					"name",
 					"message"
-				],
-				"additionalProperties": false,
-				"description": "Model to describe serialized error."
+				]
 			},
 			"NotFoundResponse": {
 				"type": "object",
-				"additionalProperties": false,
 				"properties": {
 					"notFoundId": {
 						"type": "string",
 						"description": "The id if the item that was not found."
-					},
-					"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": [
-					"message",
-					"name"
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Error"
+					}
 				],
 				"description": "The body which contains the error."
 			},
 			"SortDirection": {
+				"description": "The sort directions.",
 				"anyOf": [
 					{
-						"type": "string",
 						"const": "asc",
 						"description": "Ascending."
 					},
 					{
-						"type": "string",
 						"const": "desc",
 						"description": "Descending."
 					}
-				],
-				"description": "The sort directions."
+				]
 			}
 		},
 		"securitySchemes": {