@twin.org/node 0.9.0 → 0.9.1-next.10

package/docs/open-api/spec.json

@@ -107,6 +107,10 @@
 			"name": "Datasets",
 			"description": "Tenant-scoped CRUD over the datasets the Control Plane reads at start time to populate the federated catalogue."
 		},
+		{
+			"name": "Version Discovery",
+			"description": "RFC 8615 well-known endpoint for advertising the Dataspace Protocol versions supported by this connector."
+		},
 		{
 			"name": "Policy Administration Point",
 			"description": "Endpoints for managing ODRL policies in the Policy Administration Point"
@@ -1948,6 +1952,311 @@
 				}
 			}
 		},
+		"/authentication/audit/{id}": {
+			"get": {
+				"operationId": "authenticationAuditGet",
+				"summary": "Get an authentication audit entry",
+				"tags": [
+					"Authentication Audit"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The audit entry id.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "018f0b53d5d5704fa3a06d6ed2478575"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response from getting an authentication audit entry.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/AuthenticationAuditEntry"
+								},
+								"examples": {
+									"authenticationAuditGetResponseExample": {
+										"summary": "The response for getting an authentication audit entry.",
+										"value": {
+											"id": "018f0b53d5d5704fa3a06d6ed2478575",
+											"actorId": "user@example.com",
+											"dateCreated": "2026-01-12T09:05:23.123Z",
+											"event": "login-success",
+											"data": {
+												"organizationIdentity": "did:example:org1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"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": "authenticationAuditUpdate",
+				"summary": "Update an authentication audit entry",
+				"tags": [
+					"Authentication Audit"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The audit entry id.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "018f0b53d5d5704fa3a06d6ed2478575"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Update an authentication audit entry.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/AuditUpdateRequest"
+							},
+							"examples": {
+								"authenticationAuditUpdateRequestExample": {
+									"summary": "The request to update an authentication audit entry.",
+									"value": {
+										"data": {
+											"organizationIdentity": "did:example:org1"
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"delete": {
+				"operationId": "authenticationAuditRemove",
+				"summary": "Remove an authentication audit entry",
+				"tags": [
+					"Authentication Audit"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The audit entry id.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "018f0b53d5d5704fa3a06d6ed2478575"
+					}
+				],
+				"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
 		"/identity/{identity}": {
 			"get": {
 				"operationId": "identityResolve",
@@ -6829,6 +7138,122 @@
 				}
 			}
 		},
+		"/telemetry/metric/{id}/value/{valueId}": {
+			"get": {
+				"operationId": "telemetryGetMetricValue",
+				"summary": "Get a specific telemetry metric value",
+				"tags": [
+					"Telemetry"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the metric.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "my-counter"
+					},
+					{
+						"name": "valueId",
+						"description": "The id of the metric value.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aabbccdd11223445566"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Get a telemetry metric value response.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/TelemetryMetricValue"
+								},
+								"examples": {
+									"telemetryGetMetricValueResponseExample": {
+										"value": {
+											"id": "aabbccdd11223445566",
+											"ts": 1715252922273,
+											"value": 10
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
 		"/automation/trigger/{trigger}": {
 			"post": {
 				"operationId": "AutomationTrigger",
@@ -11624,7 +12049,7 @@
 					},
 					{
 						"name": "conditions",
-						"description": "The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemGraphVertex>.",
+						"description": "The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemGraphVertex>`.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -13387,7 +13812,7 @@
 				"parameters": [
 					{
 						"name": "conditions",
-						"description": "The conditions to filter the streams, JSON stringified IComparator[].",
+						"description": "The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemStream>`.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -14415,7 +14840,7 @@
 					},
 					{
 						"name": "conditions",
-						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -15264,7 +15689,7 @@
 				"parameters": [
 					{
 						"name": "conditions",
-						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -15525,7 +15950,7 @@
 					},
 					{
 						"name": "conditions",
-						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -15708,7 +16133,7 @@
 				"parameters": [
 					{
 						"name": "conditions",
-						"description": "The conditions to filter the stream, JSON stringified IComparator[].",
+						"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -16774,6 +17199,91 @@
 				}
 			}
 		},
+		"/.well-known/dspace-version": {
+			"get": {
+				"operationId": "getProtocolVersions",
+				"summary": "Get supported Dataspace Protocol versions (DSP 2025-1)",
+				"tags": [
+					"Version Discovery"
+				],
+				"requestBody": {
+					"description": "A REST request with no input parameters.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/NoContentRequest"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "API response for the DSP version discovery endpoint.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/DataspaceProtocolVersionResponse"
+								},
+								"examples": {
+									"getProtocolVersionsResponseExample": {
+										"value": {
+											"protocolVersions": [
+												{
+													"version": "2025-1",
+													"path": "/dataspace-control-plane/2025-1",
+													"binding": "HTTPS",
+													"serviceId": "twin-connector"
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"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"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
 		"/dataspace-control-plane/transfers/request": {
 			"post": {
 				"operationId": "requestTransfer",
@@ -20909,6 +21419,57 @@
 				],
 				"description": "The response body."
 			},
+			"AuditUpdateRequest": {
+				"description": "The body of the request.",
+				"type": "object",
+				"properties": {
+					"event": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schemas/AuthAuditEvent"
+							},
+							{
+								"type": "string"
+							}
+						],
+						"description": "The audit event that occurred."
+					},
+					"actorId": {
+						"type": "string",
+						"description": "The actor identifier, could be e-mail, username, or other unique identifier."
+					},
+					"nodeId": {
+						"type": "string",
+						"description": "The node identifier associated with the audit entry, if applicable."
+					},
+					"organizationId": {
+						"type": "string",
+						"description": "The organization identifier associated with the audit entry, if applicable."
+					},
+					"tenantId": {
+						"type": "string",
+						"description": "The tenant identifier associated with the audit entry, if applicable."
+					},
+					"ipAddressHashes": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						},
+						"description": "The hashed IP addresses of the client."
+					},
+					"userAgent": {
+						"type": "string",
+						"description": "The user agent string of the client."
+					},
+					"correlationId": {
+						"type": "string",
+						"description": "The correlation ID for request tracing."
+					},
+					"data": {
+						"description": "Additional data related to the audit entry, such as IP address, user agent, etc."
+					}
+				}
+			},
 			"AuditableItemGraphCreateRequest": {
 				"description": "The data to be used in the vertex.",
 				"type": "object",
@@ -21711,6 +22272,7 @@
 					"dateModified"
 				]
 			},
+			"DataspaceProtocolVersionResponse": {},
 			"DocumentManagementCreateRequest": {
 				"type": "object",
 				"properties": {
@@ -21858,7 +22420,7 @@
 						"description": "The query type."
 					},
 					"q": {
-						"description": "The representation of the query."
+						"description": "The representation of the query, optional depending on the query type."
 					},
 					"jsonLdContext": {
 						"type": "array",
@@ -21869,8 +22431,7 @@
 					}
 				},
 				"required": [
-					"type",
-					"q"
+					"type"
 				]
 			},
 			"GetTransferProcessResponse": {
@@ -22553,6 +23114,10 @@
 				},
 				"description": "The request body containing update parameters."
 			},
+			"NoContentRequest": {
+				"not": {},
+				"description": "Data to return send as the body."
+			},
 			"NotFoundResponse": {
 				"type": "object",
 				"properties": {