Skip to content

Forepic/35771 prelogin notice #1148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 15, 2025
Merged

Forepic/35771 prelogin notice #1148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
67b7f7b
Add pre-login notice configuration to admin-api, expose with api/v1/f…
marregui Sep 11, 2025
b75ae52
fix misnamed xml entity
marregui Sep 11, 2025
8d2ef13
fix misnamed xml entity
marregui Sep 11, 2025
f3af606
bug fix
marregui Sep 12, 2025
17db8bb
fix tests
marregui Sep 12, 2025
071e5d8
knit
marregui Sep 12, 2025
f435262
revert, jackson needs getEnabled, not isEnabled
marregui Sep 12, 2025
05f31be
trucku truck chast chast what a waste of brain lol
marregui Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 66 additions & 43 deletions ext/hivemq-edge-openapi-2025.14-SNAPSHOT.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ paths:
responses:
default:
content:
'*/*': {}
'*/*': { }
description: default response
/api/v1/auth/authenticate:
post:
Expand Down Expand Up @@ -196,8 +196,8 @@ paths:
Get all policies.

This endpoint returns the content of the policies with the content-type `application/json`.



operationId: getAllBehaviorPolicies
parameters:
- description: 'Comma-separated list of fields to include in the response. Allowed values are: id, createdAt, lastUpdatedAt, deserialization, matching, behavior, onTransitions'
Expand Down Expand Up @@ -247,7 +247,7 @@ paths:
clientIdRegex: .*
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand All @@ -265,7 +265,7 @@ paths:
clientIdRegex: .*
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand All @@ -288,7 +288,7 @@ paths:
clientIdRegex: .*
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand All @@ -306,7 +306,7 @@ paths:
clientIdRegex: .*
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand Down Expand Up @@ -340,7 +340,7 @@ paths:
clientIdRegex: .*
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand Down Expand Up @@ -387,7 +387,7 @@ paths:
version: latest
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand Down Expand Up @@ -425,10 +425,10 @@ paths:
schema:
schemaId: schema
version: latest
arguments: {}
arguments: { }
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand Down Expand Up @@ -479,8 +479,8 @@ paths:
delete:
description: |-
Deletes an existing policy.



operationId: deleteBehaviorPolicy
parameters:
- description: The identifier of the policy to delete.
Expand Down Expand Up @@ -537,8 +537,8 @@ paths:
Get a specific policy.

This endpoint returns the content of the policy with the content-type `application/json`.



operationId: getBehaviorPolicy
parameters:
- description: The identifier of the policy.
Expand Down Expand Up @@ -577,10 +577,10 @@ paths:
schema:
schemaId: schema
version: latest
arguments: {}
arguments: { }
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand Down Expand Up @@ -614,7 +614,7 @@ paths:
Update a behavior policy

The path parameter 'policyId' must match the 'id' of the policy in the request body.

operationId: updateBehaviorPolicy
parameters:
- description: The identifier of the policy.
Expand Down Expand Up @@ -649,7 +649,7 @@ paths:
version: latest
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand Down Expand Up @@ -687,10 +687,10 @@ paths:
schema:
schemaId: schema
version: latest
arguments: {}
arguments: { }
behavior:
id: Mqtt.events
arguments: {}
arguments: { }
onTransitions:
- fromState: Any.*
toState: Any.*
Expand Down Expand Up @@ -809,8 +809,8 @@ paths:
Get all data policies.

This endpoint returns the content of the policies with the content-type `application/json`.



operationId: getAllDataPolicies
parameters:
- description: 'Comma-separated list of fields to include in the response. Allowed values are: id, createdAt, lastUpdatedAt, matching, validation, onSuccess, onFailure'
Expand Down Expand Up @@ -1187,8 +1187,8 @@ paths:
delete:
description: |-
Deletes an existing data policy.



operationId: deleteDataPolicy
parameters:
- description: The identifier of the data policy to delete.
Expand Down Expand Up @@ -1239,8 +1239,8 @@ paths:
Get a specific data policy.

This endpoint returns the content of the policy with the content-type `application/json`.



operationId: getDataPolicy
parameters:
- description: The identifier of the policy.
Expand Down Expand Up @@ -1332,7 +1332,7 @@ paths:

The path parameter 'policyId' must match the 'id' of the policy in the request body.
The matching part of policies cannot be changed with an update.

operationId: updateDataPolicy
parameters:
- description: The identifier of the policy.
Expand Down Expand Up @@ -1513,8 +1513,8 @@ paths:
title: Mqtt.events
description: This FSM does not require any arguments.
type: object
required: []
properties: {}
required: [ ]
properties: { }
- if:
type: object
properties:
Expand All @@ -1527,8 +1527,8 @@ paths:
title: Publish.duplicate options
description: This FSM does not require any arguments.
type: object
required: []
properties: {}
required: [ ]
properties: { }
schema:
$ref: '#/components/schemas/JsonNode'
description: Success
Expand Down Expand Up @@ -1596,7 +1596,7 @@ paths:
- title: Mqtt.drop
description: Drops the MQTT packet that is currently processed
type: object
required: []
required: [ ]
metaData:
isTerminal: false
isDataOnly: false
Expand Down Expand Up @@ -1628,12 +1628,12 @@ paths:
- title: Mqtt.disconnect
description: Disconnects the client
type: object
required: []
required: [ ]
metaData:
isTerminal: true
isDataOnly: false
hasArguments: false
properties: {}
properties: { }
- title: Serdes.deserialize
description: Deserializes a binary MQTT message payload into a data object based on the configured JSON Schema or Protobuf schema.
type: object
Expand Down Expand Up @@ -1749,8 +1749,8 @@ paths:
Get all schemas.

This endpoint returns the content of the schemas with the content-type `application/json`.



operationId: getAllSchemas
parameters:
- description: 'Comma-separated list of fields to include in the response. Allowed values are: id, type, schemaDefinition, createdAt'
Expand Down Expand Up @@ -1959,8 +1959,8 @@ paths:
delete:
description: |-
Deletes the selected schema and all associated versions of the schema.



operationId: deleteSchema
parameters:
- description: The schema identifier of the schema versions to delete.
Expand Down Expand Up @@ -2017,8 +2017,8 @@ paths:
Get a specific schema.

This endpoint returns the content of the latest version of the schema with the content-type `application/json`.



operationId: getSchema
parameters:
- description: The identifier of the schema.
Expand Down Expand Up @@ -2487,7 +2487,7 @@ paths:
imageUrl: ''
external: true
modules:
items: []
items: [ ]
extensions:
items:
- id: extension-1
Expand Down Expand Up @@ -2640,12 +2640,12 @@ paths:
password: '*****'
loopPreventionEnabled: true
loopPreventionHopCount: 1
remoteSubscriptions: []
remoteSubscriptions: [ ]
localSubscriptions:
- filters:
- '#'
destination: prefix/{#}/bridge/${bridge.name}
excludes: []
excludes: [ ]
customUserProperties:
- key: test1
value: test2
Expand All @@ -2656,8 +2656,8 @@ paths:
keystorePassword: ''
privateKeyPassword: ''
truststorePassword: ''
protocols: []
cipherSuites: []
protocols: [ ]
cipherSuites: [ ]
keystoreType: JKS
truststoreType: JKS
verifyHostname: true
Expand Down Expand Up @@ -2777,12 +2777,12 @@ paths:
password: password
loopPreventionEnabled: true
loopPreventionHopCount: 1
remoteSubscriptions: []
remoteSubscriptions: [ ]
localSubscriptions:
- filters:
- '#'
destination: prefix/{#}/bridge/${bridge.name}
excludes: []
excludes: [ ]
customUserProperties:
- key: test1
value: test2
Expand All @@ -2793,8 +2793,8 @@ paths:
keystorePassword: ''
privateKeyPassword: ''
truststorePassword: ''
protocols: []
cipherSuites: []
protocols: [ ]
cipherSuites: [ ]
keystoreType: JKS
truststoreType: JKS
verifyHostname: true
Expand Down Expand Up @@ -2969,7 +2969,7 @@ paths:
event-list-result:
description: Example response with several events.
summary: Event List result
value: {}
value: { }
schema:
$ref: '#/components/schemas/EventList'
description: Success
Expand Down Expand Up @@ -3219,7 +3219,7 @@ paths:
description: ''
nodeType: VALUE
selectable: true
children: []
children: [ ]
schema:
$ref: '#/components/schemas/ValuesTree'
description: Success
Expand Down Expand Up @@ -5103,6 +5103,27 @@ components:
$ref: '#/components/schemas/Link'
required:
- items
PreLoginNotice:
type: object
description: The definition of a notice to be presented to the users before login
properties:
enabled:
type: boolean
description: Indicates whether the pre-login notice is enabled or not
default: false
title:
type: string
description: The title of the pre-login notice, also presented to the user
message:
type: string
description: The full text of the pre-login notice
consent:
type: string
description: An optional text for a consent checkbox that, if present, users will need to check to continue to the login itself
required:
- enabled
- message
- title
EnvironmentProperties:
type: object
description: A map of properties relating to the installation
Expand Down Expand Up @@ -5256,6 +5277,8 @@ components:
trackingAllowed:
type: boolean
description: Is the tracking of user actions allowed.
preLoginNotice:
$ref: '#/components/schemas/PreLoginNotice'
Notification:
type: object
description: List of result items that are returned by this endpoint
Expand Down
Loading
Loading