@twin.org/blob-storage-service 0.0.2-next.4 → 0.0.3-next.1

package/docs/open-api/spec.json

@@ -57,71 +57,21 @@
 					}
 				},
 				"responses": {
-					"201": {
+					"200": {
 						"description": "The rest request ended in created response.",
-						"headers": {
-							"location": {
-								"schema": {
-									"type": "string"
-								},
-								"description": "e.g. blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70"
-							}
-						}
-					},
-					"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": {
+							"text/plain": {
 								"schema": {
-									"$ref": "#/components/schemas/Error"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "UnauthorizedError",
-											"message": "component.error"
-										}
-									}
+									"$ref": "#/components/schemas/CreatedResponse"
 								}
 							}
-						}
-					},
-					"500": {
-						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
-						"content": {
-							"application/json": {
+						},
+						"headers": {
+							"location": {
 								"schema": {
-									"$ref": "#/components/schemas/Error"
+									"type": "string"
 								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "InternalServerError",
-											"message": "component.error"
-										}
-									}
-								}
+								"description": "e.g. blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70"
 							}
 						}
 					}
@@ -166,15 +116,12 @@
 						}
 					},
 					{
-						"name": "pageSize",
-						"description": "The number of entries to return per page.",
+						"name": "limit",
+						"description": "Limit the number of entities to return.",
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -203,45 +150,11 @@
 				],
 				"responses": {
 					"200": {
-						"description": "Response to getting the list of entries from a query.",
+						"description": "The resource you tried to access does not exist, see the content for more details.",
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/BlobStorageEntryList"
-								},
-								"examples": {
-									"blobStorageListResponseExample": {
-										"value": {
-											"@context": [
-												"https://schema.org",
-												"https://schema.twindev.org/blob-storage/",
-												"https://schema.twindev.org/common/"
-											],
-											"type": "ItemList",
-											"itemListElement": [
-												{
-													"@context": [
-														"https://schema.twindev.org/blob-storage/",
-														"https://schema.twindev.org/common/",
-														"https://schema.org"
-													],
-													"type": "BlobStorageEntry",
-													"id": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-													"dateCreated": "2024-01-01T00:00:00Z",
-													"encodingFormat": "application/pdf",
-													"blobSize": 42,
-													"blobHash": "sha256:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-													"fileExtension": "pdf",
-													"metadata": {
-														"@context": "https://schema.org",
-														"@type": "DigitalDocument",
-														"name": "myfile.pdf"
-													},
-													"blob": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw=="
-												}
-											]
-										}
-									}
+									"$ref": "#/components/schemas/NotFoundResponse"
 								}
 							},
 							"application/ld+json": {
@@ -284,84 +197,6 @@
 								}
 							}
 						}
-					},
-					"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"
-										}
-									}
-								}
-							}
-						}
 					}
 				}
 			}
@@ -436,35 +271,11 @@
 				],
 				"responses": {
 					"200": {
-						"description": "Response to get an entry from blob storage.",
+						"description": "The resource you tried to access does not exist, see the content for more details.",
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/BlobStorageEntry"
-								},
-								"examples": {
-									"blobStorageGetResponseExample": {
-										"value": {
-											"@context": [
-												"https://schema.twindev.org/blob-storage/",
-												"https://schema.twindev.org/common/",
-												"https://schema.org"
-											],
-											"type": "BlobStorageEntry",
-											"id": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-											"dateCreated": "2024-01-01T00:00:00Z",
-											"encodingFormat": "application/pdf",
-											"blobSize": 42,
-											"blobHash": "sha256:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-											"fileExtension": "pdf",
-											"metadata": {
-												"@context": "https://schema.org",
-												"@type": "DigitalDocument",
-												"name": "myfile.pdf"
-											},
-											"blob": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw=="
-										}
-									}
+									"$ref": "#/components/schemas/NotFoundResponse"
 								}
 							},
 							"application/ld+json": {
@@ -497,84 +308,6 @@
 								}
 							}
 						}
-					},
-					"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"
-										}
-									}
-								}
-							}
-						}
 					}
 				}
 			},
@@ -625,62 +358,12 @@
 					}
 				},
 				"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": "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"
-										}
-									}
-								}
-							}
-						}
-					},
-					"500": {
-						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+					"200": {
+						"description": "The rest request ended in success with no data.",
 						"content": {
-							"application/json": {
+							"text/plain": {
 								"schema": {
-									"$ref": "#/components/schemas/Error"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "InternalServerError",
-											"message": "component.error"
-										}
-									}
+									"$ref": "#/components/schemas/NoContentResponse"
 								}
 							}
 						}
@@ -712,83 +395,17 @@
 					}
 				],
 				"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": "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": {
+					"200": {
 						"description": "The resource you tried to access does not exist, see the content for more details.",
 						"content": {
-							"application/json": {
+							"text/plain": {
 								"schema": {
-									"$ref": "#/components/schemas/NotFoundResponse"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "NotFoundError",
-											"message": "component.error",
-											"properties": {
-												"notFoundId": "1"
-											}
-										}
-									}
+									"$ref": "#/components/schemas/NoContentResponse"
 								}
-							}
-						}
-					},
-					"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"
-										}
-									}
+									"$ref": "#/components/schemas/NotFoundResponse"
 								}
 							}
 						}
@@ -823,7 +440,7 @@
 				],
 				"responses": {
 					"200": {
-						"description": "The content of the blob, which will be a specific mime type if one can be detected from the content (or set as encodingFormat in the entry), or defaults to application/octet-stream.",
+						"description": "The resource you tried to access does not exist, see the content for more details.",
 						"content": {
 							"application/octet-stream": {
 								"schema": {
@@ -836,83 +453,10 @@
 										"value": ""
 									}
 								}
-							}
-						}
-					},
-					"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"
-										}
-									}
 								}
 							}
 						}
@@ -986,9 +530,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 2,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -999,7 +540,10 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1066,9 +610,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1083,7 +624,10 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1092,13 +636,10 @@
 					},
 					"itemListElement": {
 						"type": "array",
-						"items": false,
-						"description": "The list of entries.",
-						"prefixItems": [
-							{
-								"$ref": "#/components/schemas/BlobStorageEntry"
-							}
-						]
+						"items": {
+							"$ref": "#/components/schemas/BlobStorageEntry"
+						},
+						"description": "The list of entries."
 					},
 					"nextItem": {
 						"type": "string",

package/docs/reference/classes/BlobStorageEntry.md

@@ -91,11 +91,3 @@ Is the entry encrypted.
 > `optional` **compression**: `BlobStorageCompressionType`
 
 Is the entry compressed.
-
-***
-
-### userIdentity?
-
-> `optional` **userIdentity**: `string`
-
-The user identity that created the blob.