hivemq · vanch3d · May 15, 2025 · May 21, 2025 · May 26, 2025 · Jun 3, 2025
diff --git a/ext/hivemq-edge-openapi-2025.9-SNAPSHOT.yaml b/ext/hivemq-edge-openapi-2025.9-SNAPSHOT.yaml
@@ -14,7 +14,7 @@ info:
     ## OpenAPI
     HiveMQ's REST API provides an OpenAPI 3.0 schema definition that can imported into popular API tooling (e.g. Postman) or can be used to generate client-code for multiple programming languages.
   title: HiveMQ Edge REST API
-  version: 2025.4-SNAPSHOT
+  version: 2025.9-SNAPSHOT
   x-logo:
     url: https://www.hivemq.com/img/svg/hivemq-bee.svg
 tags:
@@ -1541,6 +1541,7 @@ paths:
         - Data Hub - FSM
   /api/v1/data-hub/functions:
     get:
+      deprecated: true
       description: This endpoints provides the means to get information on the available Functions for the HiveMQ Data Hub. The information is provided in form of a Json Schema.
       operationId: getFunctions
       responses:
@@ -1700,6 +1701,26 @@ paths:
       summary: Get all functions as a JSON Schema
       tags:
         - Data Hub - Functions
+  /api/v1/data-hub/function-specs:
+    get:
+      description: This endpoints provides the means to get information on the available Functions for the HiveMQ Data Hub.
+      operationId: getFunctionSpecs
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FunctionSpecsList'
+          description: Success
+        '500':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemDetails'
+          description: Internal server error
+      summary: Get all functions as a list of function specifications
+      tags:
+        - Data Hub - Functions
   /api/v1/data-hub/schemas:
     get:
       description: |-
@@ -4748,6 +4769,67 @@ components:
             $ref: '#/components/schemas/DataPolicy'
     Errors:
       type: object
+    BehaviorPolicyTransitionEvent:
+      type: string
+      description: Accepted event in transition
+      enum:
+        - Event.OnAny
+        - Connection.OnDisconnect
+        - Mqtt.OnInboundConnect
+        - Mqtt.OnInboundDisconnect
+        - Mqtt.OnInboundPublish
+        - Mqtt.OnInboundSubscribe
+    FunctionMetadata:
+      description: Metadata for operation functions
+      type: object
+      properties:
+        isTerminal:
+          type: boolean
+          description: The function is a terminal element of a pipeline
+        isDataOnly:
+          type: boolean
+          description: The function is only available for Data Policies
+        hasArguments:
+          type: boolean
+          description: The function has extra arguments
+        inLicenseAllowed:
+          type: boolean
+          description: The function can be used with the current user's license
+        supportedEvents:
+          type: array
+          items:
+            $ref: '#/components/schemas/BehaviorPolicyTransitionEvent'
+    FunctionSpecs:
+      description: The configuration of a DataHub operation function
+      type: object
+      properties:
+        functionId:
+          type: string
+          description: The unique name of the function
+        metadata:
+          $ref: '#/components/schemas/FunctionMetadata'
+          description: The metadata associated with the function
+        schema:
+          $ref: '#/components/schemas/JsonNode'
+          description: the full JSON-Schema describimng the function and its arguments
+        uiSchema:
+          $ref: '#/components/schemas/JsonNode'
+          description: An optional UI Schema to customise the rendering of the configuraton form
+      required:
+        - functionId
+        - metadata
+        - schema
+    FunctionSpecsList:
+      type: object
+      description: List of function configurations
+      properties:
+        items:
+          type: array
+          description: List of function configurations
+          items:
+            $ref: '#/components/schemas/FunctionSpecs'
+      required:
+        - items
     PolicySchema:
       type: object
       properties:

diff --git a/ext/openAPI/components/schemas/BehaviorPolicyTransitionEvent.yaml b/ext/openAPI/components/schemas/BehaviorPolicyTransitionEvent.yaml
@@ -0,0 +1,9 @@
+type: string
+description: Accepted event in transition
+enum:
+  - Event.OnAny
+  - Connection.OnDisconnect
+  - Mqtt.OnInboundConnect
+  - Mqtt.OnInboundDisconnect
+  - Mqtt.OnInboundPublish
+  - Mqtt.OnInboundSubscribe
diff --git a/ext/openAPI/components/schemas/FunctionMetadata.yaml b/ext/openAPI/components/schemas/FunctionMetadata.yaml
@@ -0,0 +1,21 @@
+description: Metadata for operation functions
+type: object
+properties:
+  isTerminal:
+    type: boolean
+    description: The function is a terminal element of a pipeline
+  isDataOnly:
+    type: boolean
+    description: The function is only available for Data Policies
+  hasArguments:
+    type: boolean
+    description: The function has extra arguments
+  inLicenseAllowed:
+    type: boolean
+    description: The function can be used with the current user's license
+  supportedEvents:
+    type: array
+    items:
+      $ref: ./BehaviorPolicyTransitionEvent.yaml
+
+
diff --git a/ext/openAPI/components/schemas/FunctionSpecs.yaml b/ext/openAPI/components/schemas/FunctionSpecs.yaml
@@ -0,0 +1,19 @@
+description: The configuration of a DataHub operation function
+type: object
+properties:
+  functionId:
+    type: string
+    description: The unique name of the function
+  metadata:
+    $ref: ./FunctionMetadata.yaml
+    description: The metadata associated with the function
+  schema:
+    $ref: ./JsonNode.yaml
+    description: the full JSON-Schema describimng the function and its arguments
+  uiSchema:
+    $ref: ./JsonNode.yaml
+    description: An optional UI Schema to customise the rendering of the configuraton form
+required:
+  - functionId
+  - metadata
+  - schema
diff --git a/ext/openAPI/components/schemas/FunctionSpecsList.yaml b/ext/openAPI/components/schemas/FunctionSpecsList.yaml
@@ -0,0 +1,10 @@
+type: object
+description: List of function configurations
+properties:
+  items:
+    type: array
+    description: List of function configurations
+    items:
+      $ref: ./FunctionSpecs.yaml
+required:
+  - items
diff --git a/ext/openAPI/openapi.yaml b/ext/openAPI/openapi.yaml
@@ -30,7 +30,7 @@ info:
     imported into popular API tooling (e.g. Postman) or can be used to generate
     client-code for multiple programming languages.
   title: HiveMQ Edge REST API
-  version: 2025.4-SNAPSHOT
+  version: 2025.9-SNAPSHOT
   x-logo:
     url: https://www.hivemq.com/img/svg/hivemq-bee.svg
 tags:
@@ -176,6 +176,8 @@ paths:
     $ref: paths/api_v1_data-hub_fsm.yaml
   /api/v1/data-hub/functions:
     $ref: paths/api_v1_data-hub_functions.yaml
+  /api/v1/data-hub/function-specs:
+    $ref: paths/api_v1_data-hub_function-specs.yaml
   /api/v1/data-hub/schemas:
     $ref: paths/api_v1_data-hub_schemas.yaml
   /api/v1/data-hub/schemas/{schemaId}:

diff --git a/ext/openAPI/paths/api_v1_data-hub_function-specs.yaml b/ext/openAPI/paths/api_v1_data-hub_function-specs.yaml
@@ -0,0 +1,21 @@
+get:
+  description: >-
+    This endpoints provides the means to get information on the available
+    Functions for the HiveMQ Data Hub.
+  operationId: getFunctionSpecs
+  responses:
+    '200':
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/FunctionSpecsList.yaml
+      description: Success
+    '500':
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/ProblemDetails.yaml
+      description: Internal server error
+  summary: Get all functions as a list of function specifications
+  tags:
+    - Data Hub - Functions
diff --git a/ext/openAPI/paths/api_v1_data-hub_functions.yaml b/ext/openAPI/paths/api_v1_data-hub_functions.yaml
@@ -1,4 +1,5 @@
 get:
+  deprecated: true
   description: >-
     This endpoints provides the means to get information on the available
     Functions for the HiveMQ Data Hub. The information is provided in form of a

diff --git a/hivemq-edge-frontend/package.json b/hivemq-edge-frontend/package.json
@@ -6,13 +6,14 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
+    "build:tsc": "tsc -b",
     "lint:eslint": "eslint src --report-unused-disable-directives --max-warnings 0",
     "lint:eslint:fix": "eslint src --report-unused-disable-directives --max-warnings 0 --fix",
     "lint:prettier": "prettier --check .",
     "lint:prettier:write": "prettier --write .",
     "lint:stylelint": "stylelint './src/**/*.css'",
     "lint:all": "eslint src  --report-unused-disable-directives --max-warnings 0 && prettier --check .",
-    "dev:openAPI": "openapi --input '../../../../hivemq-edge/ext/hivemq-edge-openapi-2025.8-SNAPSHOT.yaml' -o ./src/api/__generated__ -c axios --name HiveMqClient --exportSchemas true",
+    "dev:openAPI": "openapi --input '../ext/hivemq-edge-openapi-2025.9-SNAPSHOT.yaml' -o ./src/api/__generated__ -c axios --name HiveMqClient --exportSchemas true",
     "dev:chakra:types": "chakra-cli tokens './src/modules/Theme/themeHiveMQ.ts' --out 'node_modules/.pnpm/@[email protected]/node_modules/@chakra-ui/styled-system/dist/theming.types.d.ts'",
     "cypress:open": "cypress open",
     "cypress:open:component": "cypress open --component --browser chrome",

diff --git a/hivemq-edge-frontend/src/__test-utils__/msw/handlers.ts b/hivemq-edge-frontend/src/__test-utils__/msw/handlers.ts
@@ -9,9 +9,8 @@ import { handlers as DataHubDataPoliciesService } from '@/extensions/datahub/api
 import { handlers as DataHubBehaviorPoliciesService } from '@/extensions/datahub/api/hooks/DataHubBehaviorPoliciesService/__handlers__'
 import { handlers as DataHubSchemasService } from '@/extensions/datahub/api/hooks/DataHubSchemasService/__handlers__'
 import { handlers as DataHubScriptsService } from '@/extensions/datahub/api/hooks/DataHubScriptsService/__handlers__'
-import { handlers as combinerHandlers } from '@/api/hooks/useCombiners/__handlers__'
+import { handlersWithoutLicense as DataHubFunctionsService } from '@/extensions/datahub/api/hooks/DataHubFunctionsService/__handlers__'
 
-import { safeTopicSchemaHandlers } from '@/api/hooks/useDomainModel/__handlers__'
 import type { MQTTSample } from '@/hooks/usePrivateMqttClient/type.ts'
 
 export const handlers = [
@@ -33,12 +32,13 @@ export const createHandlersWithMQTTClient = (
   _onSampling?: (topicFilter: string) => Promise<MQTTSample[]> | undefined
 ) => {
   return [
-    ...combinerHandlers,
+    ...DataHubFunctionsService,
+    // ...combinerHandlers,
     // ...DeviceHandlers,
     // ...TopicFilterHandlers,
     // Domain & Schemas
     // ...schemaHandlers(onSampling),
-    ...safeTopicSchemaHandlers,
+    // ...safeTopicSchemaHandlers,
     // ...safeWritingSchemaHandlers,
   ]
 }
diff --git a/hivemq-edge-frontend/src/api/__generated__/HiveMqClient.ts b/hivemq-edge-frontend/src/api/__generated__/HiveMqClient.ts
diff --git a/hivemq-edge-frontend/src/api/__generated__/core/OpenAPI.ts b/hivemq-edge-frontend/src/api/__generated__/core/OpenAPI.ts
diff --git a/hivemq-edge-frontend/src/api/__generated__/index.ts b/hivemq-edge-frontend/src/api/__generated__/index.ts
diff --git a/hivemq-edge-frontend/src/api/__generated__/models/BehaviorPolicyTransitionEvent.ts b/hivemq-edge-frontend/src/api/__generated__/models/BehaviorPolicyTransitionEvent.ts
diff --git a/hivemq-edge-frontend/src/api/__generated__/models/FunctionMetadata.ts b/hivemq-edge-frontend/src/api/__generated__/models/FunctionMetadata.ts
diff --git a/hivemq-edge-frontend/src/api/__generated__/models/FunctionSpecs.ts b/hivemq-edge-frontend/src/api/__generated__/models/FunctionSpecs.ts