Skip to content

Commit 69ea90d

Browse files
authored
Merge pull request #988
* fix(33305): fix snapshot version * feat(33305): add new endpoint for the function specs * feat(33305): add schemas for the function specs * feat(33305): deprecating the old endpoint * feat(33305): refactoring the list to add items * feat(33305): add descriptions * feat(33305): add supported events * feat(33305): add transition event * chore(33305): fix typos
1 parent 36e6133 commit 69ea90d

File tree

8 files changed

+85
-2
lines changed

8 files changed

+85
-2
lines changed

ext/hivemq-edge-openapi-2025.9-SNAPSHOT.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ info:
1414
## OpenAPI
1515
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.
1616
title: HiveMQ Edge REST API
17-
version: 2025.4-SNAPSHOT
17+
version: 2025.9-SNAPSHOT
1818
x-logo:
1919
url: https://www.hivemq.com/img/svg/hivemq-bee.svg
2020
tags:
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
type: string
2+
description: Accepted event in transition
3+
enum:
4+
- Event.OnAny
5+
- Connection.OnDisconnect
6+
- Mqtt.OnInboundConnect
7+
- Mqtt.OnInboundDisconnect
8+
- Mqtt.OnInboundPublish
9+
- Mqtt.OnInboundSubscribe
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
description: Metadata for operation functions
2+
type: object
3+
properties:
4+
isTerminal:
5+
type: boolean
6+
description: The function is a terminal element of a pipeline
7+
isDataOnly:
8+
type: boolean
9+
description: The function is only available for Data Policies
10+
hasArguments:
11+
type: boolean
12+
description: The function has extra arguments
13+
inLicenseAllowed:
14+
type: boolean
15+
description: The function can be used with the current user's license
16+
supportedEvents:
17+
type: array
18+
items:
19+
$ref: ./BehaviorPolicyTransitionEvent.yaml
20+
21+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
description: The configuration of a DataHub operation function
2+
type: object
3+
properties:
4+
functionId:
5+
type: string
6+
description: The unique name of the function
7+
metadata:
8+
$ref: ./FunctionMetadata.yaml
9+
description: The metadata associated with the function
10+
schema:
11+
$ref: ./JsonNode.yaml
12+
description: the full JSON-Schema describimng the function and its arguments
13+
uiSchema:
14+
$ref: ./JsonNode.yaml
15+
description: An optional UI Schema to customise the rendering of the configuraton form
16+
required:
17+
- functionId
18+
- metadata
19+
- schema
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
type: object
2+
description: List of function configurations
3+
properties:
4+
items:
5+
type: array
6+
description: List of function configurations
7+
items:
8+
$ref: ./FunctionSpecs.yaml
9+
required:
10+
- items

ext/openAPI/openapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ info:
3030
imported into popular API tooling (e.g. Postman) or can be used to generate
3131
client-code for multiple programming languages.
3232
title: HiveMQ Edge REST API
33-
version: 2025.4-SNAPSHOT
33+
version: 2025.9-SNAPSHOT
3434
x-logo:
3535
url: https://www.hivemq.com/img/svg/hivemq-bee.svg
3636
tags:
@@ -176,6 +176,8 @@ paths:
176176
$ref: paths/api_v1_data-hub_fsm.yaml
177177
/api/v1/data-hub/functions:
178178
$ref: paths/api_v1_data-hub_functions.yaml
179+
/api/v1/data-hub/function-specs:
180+
$ref: paths/api_v1_data-hub_function-specs.yaml
179181
/api/v1/data-hub/schemas:
180182
$ref: paths/api_v1_data-hub_schemas.yaml
181183
/api/v1/data-hub/schemas/{schemaId}:
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
get:
2+
description: >-
3+
This endpoints provides the means to get information on the available
4+
Functions for the HiveMQ Data Hub.
5+
operationId: getFunctionSpecs
6+
responses:
7+
'200':
8+
content:
9+
application/json:
10+
schema:
11+
$ref: ../components/schemas/FunctionSpecsList.yaml
12+
description: Success
13+
'500':
14+
content:
15+
application/json:
16+
schema:
17+
$ref: ../components/schemas/ProblemDetails.yaml
18+
description: Internal server error
19+
summary: Get all functions as a list of function specifications
20+
tags:
21+
- Data Hub - Functions

ext/openAPI/paths/api_v1_data-hub_functions.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
get:
2+
deprecated: true
23
description: >-
34
This endpoints provides the means to get information on the available
45
Functions for the HiveMQ Data Hub. The information is provided in form of a

0 commit comments

Comments
 (0)