@twin.org/notarization-service 0.0.3-next.1

package/docs/open-api/spec.json

@@ -0,0 +1,712 @@
+{
+	"openapi": "3.1.1",
+	"info": {
+		"title": "TWIN - Test Endpoints",
+		"description": "REST API for TWIN - 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": "Notarization",
+			"description": "Endpoints which are modelled to access a notarization service."
+		}
+	],
+	"paths": {
+		"/notarization": {
+			"post": {
+				"operationId": "notarizationCreate",
+				"summary": "Create a notarization",
+				"tags": [
+					"Notarization"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Request to create a notarization.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/NotarizationCreateRequest"
+							},
+							"examples": {
+								"notarizationCreateExample": {
+									"value": {
+										"mode": "dynamic",
+										"data": {},
+										"description": "My first notarization"
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"201": {
+						"description": "The rest request ended in created response.",
+						"headers": {
+							"location": {
+								"schema": {
+									"type": "string"
+								},
+								"description": "e.g. 123"
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/notarization/{id}": {
+			"get": {
+				"operationId": "notarizationGet",
+				"summary": "Get a notarization",
+				"tags": [
+					"Notarization"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the notarization to get.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "123"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response for getting a notarization.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Notarization"
+								},
+								"examples": {
+									"notarizationGetResponseExample": {
+										"value": {
+											"id": "123",
+											"mode": "dynamic",
+											"dateCreated": "2026-01-01T00:00:00.000Z",
+											"data": {},
+											"description": "A notarization"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"delete": {
+				"operationId": "notarizationRemove",
+				"summary": "Remove a notarization",
+				"tags": [
+					"Notarization"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the notarization to remove.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "123"
+					}
+				],
+				"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"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"put": {
+				"operationId": "notarizationUpdate",
+				"summary": "Update a notarization",
+				"tags": [
+					"Notarization"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the notarization to update.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "123"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Request to update a notarization.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/Notarization"
+							},
+							"examples": {
+								"notarizationUpdateExample": {
+									"value": {
+										"id": "123",
+										"mode": "dynamic",
+										"dateCreated": "2026-01-01T00:00:00.000Z",
+										"data": {},
+										"description": "Updated notarization"
+									}
+								}
+							}
+						}
+					}
+				},
+				"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/notarization/{id}/transfer": {
+			"post": {
+				"operationId": "notarizationTransfer",
+				"summary": "Transfer a notarization",
+				"tags": [
+					"Notarization"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the notarization to transfer.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "123"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Request to transfer a notarization.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/NotarizationTransferRequest"
+							},
+							"examples": {
+								"notarizationTransferExample": {
+									"value": {
+										"recipientAddress": "recipient-address-1"
+									}
+								}
+							}
+						}
+					}
+				},
+				"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"components": {
+		"schemas": {
+			"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."
+					},
+					"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"
+				]
+			},
+			"Notarization": {
+				"description": "Interface describing a notarization.",
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string",
+						"description": "The unique identifier of the notarization."
+					},
+					"mode": {
+						"$ref": "#/components/schemas/NotarizationMode"
+					},
+					"dateCreated": {
+						"type": "string",
+						"description": "The date and time when the notarization was created, in ISO 8601 format."
+					},
+					"dateModified": {
+						"type": "string",
+						"description": "The date and time when the notarization was last modified, in ISO 8601 format."
+					},
+					"data": {
+						"type": "array",
+						"items": {
+							"type": "number"
+						},
+						"description": "The notarization data as a byte array."
+					},
+					"immutableDescription": {
+						"type": "string",
+						"description": "An optional description of the notarization that cannot be changed after creation."
+					},
+					"description": {
+						"type": "string",
+						"description": "An optional description of the notarization that can be modified until the notarization is locked."
+					},
+					"deleteLockDateTime": {
+						"type": "string",
+						"description": "An optional lock date, in ISO 8601 format, that prevents deletion until the date is reached.\nUsed only in Locked Notarization, it prevents the object from being deleted until the lock expires."
+					},
+					"transferLockUntilDestroyed": {
+						"type": "boolean",
+						"description": "An optional flag indicating transfer lock is active until the notarization is destroyed.\nUsed only in Dynamic Notarization."
+					},
+					"transferLockDateTime": {
+						"type": "string",
+						"description": "An optional transfer lock date-time, in ISO 8601 format.\nUsed only in Dynamic Notarization."
+					}
+				},
+				"required": [
+					"id",
+					"mode",
+					"dateCreated",
+					"data"
+				]
+			},
+			"NotarizationCreateRequest": {
+				"type": "object",
+				"properties": {
+					"mode": {
+						"$ref": "#/components/schemas/NotarizationMode"
+					},
+					"dateModified": {
+						"type": "string",
+						"description": "The date and time when the notarization was last modified, in ISO 8601 format."
+					},
+					"data": {
+						"type": "array",
+						"items": {
+							"type": "number"
+						},
+						"description": "The notarization data as a byte array."
+					},
+					"immutableDescription": {
+						"type": "string",
+						"description": "An optional description of the notarization that cannot be changed after creation."
+					},
+					"description": {
+						"type": "string",
+						"description": "An optional description of the notarization that can be modified until the notarization is locked."
+					},
+					"deleteLockDateTime": {
+						"type": "string",
+						"description": "An optional lock date, in ISO 8601 format, that prevents deletion until the date is reached.\nUsed only in Locked Notarization, it prevents the object from being deleted until the lock expires."
+					},
+					"transferLockUntilDestroyed": {
+						"type": "boolean",
+						"description": "An optional flag indicating transfer lock is active until the notarization is destroyed.\nUsed only in Dynamic Notarization."
+					},
+					"transferLockDateTime": {
+						"type": "string",
+						"description": "An optional transfer lock date-time, in ISO 8601 format.\nUsed only in Dynamic Notarization."
+					},
+					"namespace": {
+						"type": "string",
+						"description": "The namespace of the connector to use for the notarization, defaults to component configured namespace."
+					}
+				},
+				"required": [
+					"mode",
+					"data"
+				],
+				"description": "The request data."
+			},
+			"NotarizationMode": {
+				"description": "Supported notarization mode values.",
+				"anyOf": [
+					{
+						"const": "dynamic",
+						"description": "Dynamic notarization mode."
+					},
+					{
+						"const": "locked",
+						"description": "Locked notarization mode."
+					}
+				]
+			},
+			"NotarizationTransferRequest": {
+				"type": "object",
+				"properties": {
+					"recipientAddress": {
+						"type": "string",
+						"description": "The recipient address."
+					}
+				},
+				"required": [
+					"recipientAddress"
+				],
+				"description": "The request data."
+			}
+		},
+		"securitySchemes": {
+			"jwtBearerAuthScheme": {
+				"type": "http",
+				"scheme": "bearer",
+				"bearerFormat": "JWT"
+			}
+		}
+	}
+}