Update topic-structure.md with new tokens for Property communication #996
Conversation
jrdouceur
requested review from
avishekpant,
timtay-microsoft,
olivakar,
maximsemenov80,
cartertinney,
RLeclair and
clecompt-msft
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR updates the topic structure documentation to include support for Property communication in Azure IoT Operations. The changes introduce new tokens and patterns specifically for Property operations alongside the existing Telemetry and Command functionality.
- Adds Property communication support with new tokens for maintainer, consumer, property name, and action
- Updates topic pattern definitions to include Property alongside Telemetry and Command
- Provides comprehensive documentation and examples for Property topic structure
Co-authored-by: Copilot <[email protected]>
| @@ -75,6 +76,57 @@ deployments/gen/3/sensors/west/building22/sensor-temp-1628/telemetry | |||
| > * If the `telemetryTopic` property contains a `{telemetryName}` token, each Telemetry is assigned a separate MQTT pub/sub topic, and each is published separately. This may be more efficient for Telemetries that have no logical or temporal relationship to each other. | |||
| > * If the `telemetryTopic` property does not contain a `{telemetryName}` token, all Telemetries in the Interface are grouped into a collection that is published in a combined payload. This does not require any given payload to express values for all Telemetries, but it provides the option of including multiple Telemetries in a single published message. | |||
|
|
|||
| ## Property | |||
There was a problem hiding this comment.
I believe this file should be split into two separate documents: one focusing on topic structure at the protocol level, and another detailing accepted protocol tokens at the codegen level. According to ADR 1 we do not recognize any specific tokens at the protocol level - including them in the topic structure documentation could be confusing to someone not using codegen
The topic-structure.md for the protocol should primarily contain information from the ADR. Any references to specific topic tokens such as {modelId} should be documented in the codegen file, including the recently added Property section
Is this something we can do in this PR? We can also leave a TODO or a note at the top and I can get to separating them at a later time
There was a problem hiding this comment.
I took this whole document to be describing codegen structure, per ADR1, since most of it is focused on the tokens rather than the syntax. It might be enough to just put a note to that effect in this file.
There was a problem hiding this comment.
Indeed, this all relates to codegen. When the doc was originally written, it was intended to be implemented in the SDKs, but then we made a collective decision to move these structural aspects into codegen only.
The present PR is merely adding information from the recently approved ADR 23 into this archival document.
No description provided.