Merge pull request #1016

* feat(33975): add the path and schemas for the interpolation variables…

* feat(33975): add tag description

* fix(33975): fix version

* Update ext/openAPI/components/schemas/InterpolationVariableList.yaml

* fix(33975): replacing the booleans with a multi-option select

* fix(33975): fix ref and required

* fix(33975): fix typo

Author: vanch3d

ext/openAPI/components/schemas/InterpolationVariable.yaml

@@ -0,0 +1,29 @@
+type: object
+required:
+  - variable
+  - type
+  - description
+  - policyType
+properties:
+  variable:
+    type: string
+    description: The unique variable name
+  type:
+    type: string
+    enum: ["string", "long"]
+  description:
+    type: string
+    description: The description of the variable name
+  policyType:
+    type: array
+    description: The list of policy types this variable can be used with
+    uniqueItems: true
+    items:
+      $ref: ./PolicyType.yaml
+example:
+  variable: clientId
+  type: string
+  description: The MQTT client ID
+  policyType:
+    - DATA_POLICY
+    - BEHAVIOR_POLICY

ext/openAPI/components/schemas/InterpolationVariableList.yaml

@@ -0,0 +1,22 @@
+type: object
+description: The list of interpolation variables that can be used in this Datahub instance
+properties:
+  items:
+    type: array
+    items:
+      $ref: ./InterpolationVariable.yaml
+required:
+  - items
+example:
+  items:
+    - variable: clientId
+      type: string
+      description: The MQTT client ID
+      policyType:
+        - DATA_POLICY
+        - BEHAVIOR_POLICY
+    - variable: topic
+      type: string
+      description: The MQTT topic to which the MQTT message was published xxx
+      policyType:
+        - DATA_POLICY

ext/openAPI/components/schemas/PolicyType.yaml

@@ -0,0 +1,5 @@
+  description: The type of policy in Data Hub
+  type: string
+  enum:
+    - DATA_POLICY
+    - BEHAVIOR_POLICY

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.9-SNAPSHOT
+  version: 2025.10-SNAPSHOT
   x-logo:
     url: https://www.hivemq.com/img/svg/hivemq-bee.svg
 tags:
@@ -63,6 +63,8 @@ tags:
       This resource bundles endpoints for the available Functions for the HiveMQ
       Data Hub. Currently this is limited to getting the available Functions.
     name: Data Hub - Functions
+  - description: This resource bundles endpoints for the interpolation features.
+    name: Data Hub - Interpolation
   - description: >-
       Policies describe how you want the HiveMQ broker to validate the behavior
       of MQTT clients.
@@ -176,6 +178,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/interpolation-variables:
+    $ref: paths/api_v1_data-hub_interpolation-variables.yaml
   /api/v1/data-hub/function-specs:
     $ref: paths/api_v1_data-hub_function-specs.yaml
   /api/v1/data-hub/schemas:

ext/openAPI/paths/api_v1_data-hub_interpolation-variables.yaml

@@ -0,0 +1,19 @@
+get:
+  description: This endpoint provides the means to get information on the interpolation variables available for the HiveMQ Data Hub.
+  operationId: getVariables
+  responses:
+    '200':
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/InterpolationVariableList.yaml
+      description: Success
+    '500':
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/ProblemDetails.yaml
+      description: Internal server error
+  summary: Get all interpolation variables
+  tags:
+    - Data Hub - Interpolation