Update dispatch.proto to clarify payload usage#274
Merged
Marenz merged 1 commit intofrequenz-floss:v0.x.xfrom Aug 11, 2025
Merged
Update dispatch.proto to clarify payload usage#274Marenz merged 1 commit intofrequenz-floss:v0.x.xfrom
Marenz merged 1 commit intofrequenz-floss:v0.x.xfrom
Conversation
Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
github-actions
bot
added
the
part:protobuf
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation for the payload field in the DispatchData message by adding clarification on expected usage and providing a concrete example. The change addresses issue #115 by improving developer understanding of how to structure and utilize the payload field.
Key Changes
- Added detailed documentation explaining payload format expectations and downstream application responsibilities
- Included a practical JSON example demonstrating microgrid operational parameters
- Enhanced the existing payload field documentation with usage context and real-world application scenarios
Marenz
added
the
cmd:skip-release-notes
ktickner
approved these changes
Aug 11, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #115