Skip to content

Add {eventGroupName} as a possible placeholder in connector metadata schema #1049

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add {eventGroupName} as a possible placeholder in connector metadata schema #1049

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
358959a
Add {eventGroupName} as a possible placeholder in connector metadata …
timtay-microsoft Oct 17, 2025
c1280a5
feedback
timtay-microsoft Oct 17, 2025
7b79fac
Merge branch 'main' into timtay/description
timtay-microsoft Nov 5, 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
6 changes: 3 additions & 3 deletions doc/akri_connector/connector-metadata-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
},
"topic": {
"type": "string",
"description": "The default MQTT topic that will be published to. Values are allowed to contain deploy-time parameters like 'mqtt/{deviceName}/{inboundEndpointName}/myMessages'. The supported parameter tokens are: {deviceName}, {inboundEndpointName}, {assetName}, {datasetName}, {eventName}, {streamName}, and {kubernetesNamespace}. Dataset/event/stream name tokens are only allowed if the configured destination is for a dataset/event/stream."
"description": "The default MQTT topic that will be published to. Values are allowed to contain deploy-time parameters like 'mqtt/{deviceName}/{inboundEndpointName}/myMessages'. The supported parameter tokens are: {deviceName}, {inboundEndpointName}, {assetName}, {datasetName}, {eventGroupName}, {eventName}, {streamName}, and {kubernetesNamespace}. Dataset/eventGroup/event/stream name tokens are only allowed if the configured destination is for a dataset/event/stream."
Copy link
Contributor

@koepalex koepalex Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we remove eventName as this list also not contain datapointName ?

Copy link
Member

@vaavva vaavva Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would make sense to keep eventName since you can have a destination per event, whereas you can't have a destination per datapoint

Copy link
Member Author

@timtay-microsoft timtay-microsoft Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. Events haven't really changed with the addition of event groups. This list seems correct to me as-is

},
"qos": {
"type": "integer",
Expand Down Expand Up @@ -66,7 +66,7 @@
},
"key": {
"type": "string",
"description": "The default broker state store key that will be published to. Values are allowed to contain deploy-time parameters like 'dss/{deviceName}/{inboundEndpointName}'. The supported parameter tokens are: {deviceName}, {inboundEndpointName}, {assetName}, {datasetName}, {eventName}, {streamName}, and {kubernetesNamespace}. Dataset/event/stream name tokens are only allowed if the configured destination is for a dataset/event/stream."
"description": "The default broker state store key that will be published to. Values are allowed to contain deploy-time parameters like 'dss/{deviceName}/{inboundEndpointName}'. The supported parameter tokens are: {deviceName}, {inboundEndpointName}, {assetName}, {datasetName}, {eventGroupName}, {eventName}, {streamName}, and {kubernetesNamespace}. Dataset/eventGroup/event/stream name tokens are only allowed if the configured destination is for a dataset/event/stream."
}
},
"additionalProperties": false,
Expand All @@ -83,7 +83,7 @@
},
"path": {
"type": "string",
"description": "The default path that storage will use. Values are allowed to contain deploy-time parameters like 'storage/{deviceName}/{inboundEndpointName}'. The supported parameter tokens are: {deviceName}, {inboundEndpointName}, {assetName}, {datasetName}, {eventName}, {streamName}, and {kubernetesNamespace}. Dataset/event/stream name tokens are only allowed if the configured destination is for a dataset/event/stream."
"description": "The default path that storage will use. Values are allowed to contain deploy-time parameters like 'storage/{deviceName}/{inboundEndpointName}'. The supported parameter tokens are: {deviceName}, {inboundEndpointName}, {assetName}, {datasetName}, {eventGroupName}, {eventName}, {streamName}, and {kubernetesNamespace}. Dataset/eventGroup/event/stream name tokens are only allowed if the configured destination is for a dataset/event/stream."
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -174,7 +174,7 @@
"properties": {
"imageName": {
"type": "string",
"description": "The container image name for the connector. For example: 'myconnector'"

Check warning on line 177 in doc/akri_connector/connector-metadata-schema.json

View workflow job for this annotation

GitHub Actions / CI-spelling 

Unknown word (myconnector) Suggestions: (myconnect, myconnection, myConnect, Myconnect, myconnectio)
},
"tag": {
"type": "string",
Expand All @@ -188,7 +188,7 @@
"properties": {
"imageName": {
"type": "string",
"description": "The container image name for the connector. For example: 'myconnector'"

Check warning on line 191 in doc/akri_connector/connector-metadata-schema.json

View workflow job for this annotation

GitHub Actions / CI-spelling 

Unknown word (myconnector) Suggestions: (myconnect, myconnection, myConnect, Myconnect, myconnectio)
},
"digest": {
"type": "string",
Expand Down Expand Up @@ -671,8 +671,8 @@
},
"recommendedAllocationPolicy": {
"type": "string",
"description": "The recommended configuration to use for allocating device inbound endpoints for the connector instances. Only 'bucketized' is currently supported.",

Check warning on line 674 in doc/akri_connector/connector-metadata-schema.json

View workflow job for this annotation

GitHub Actions / CI-spelling 

Unknown word (bucketized) Suggestions: (bucketed, bucketing, bulletined)
"enum": ["bucketized"]

Check warning on line 675 in doc/akri_connector/connector-metadata-schema.json

View workflow job for this annotation

GitHub Actions / CI-spelling 

Unknown word (bucketized) Suggestions: (bucketed, bucketing, bulletined)
},
"recommendedReplicas": {
"type": "integer",
Expand Down
Loading