Add an ElectricalComponentError message
#308
Merged
Conversation
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
github-actions
bot
added
the
part:protobuf
Contributor
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto:505
- The warnings field type has been changed from ElectricalComponentErrorCode to ElectricalComponentError. Please verify that all downstream implementations consuming this field are updated accordingly to handle the extended error information.
// List of non-critical warnings detected for the component.
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto:516
- The errors field type has been updated to ElectricalComponentError. Ensure that consumers expecting only error codes are capable of processing the additional error context provided by the new message schema.
// No duplicate error codes allowed.
tiyash-basu-frequenz
force-pushed
the
component_status_update
branch
from
8908df4 to
5ba78ea
Compare
tiyash-basu-frequenz
force-pushed
the
component_status_update
branch
from
5ba78ea to
6b6ea04
Compare
ktickner
reviewed
Apr 15, 2025
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
Show resolved
Hide resolved
ktickner
reviewed
Apr 15, 2025
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
Show resolved
Hide resolved
ktickner
reviewed
Apr 15, 2025
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
Show resolved
Hide resolved
Contributor
|
Probably for another PR, but maybe it can be renamed to |
Contributor
Author
Sure. I have a few more contenders:
Also, I would also extend this to the enum name as well. Will create an issue depending upon how the discussions in this PR go. |
|
I prefer issue or diagnostic. |
This commit adds the `ElectricalComponentError` message to the `electrical_components.proto` file. This message is designed to represent error or warning conditions reported by microgrid electrical components. It extends a standardized error code with contextual information useful for diagnostics or vendor-specific insights. Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
component_status_update
branch
from
6b6ea04 to
c447367
Compare
Contributor
Would align well with other APIs. |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Apr 15, 2025
…309) This commit improves the naming of the `ElectricalComponentError` message to `ElectricalComponentDiagnostic`, to better reflect its purpose of representing both warnings and errors in microgrid electrical components. Followed up from this comment: #308 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
This commit adds the
ElectricalComponentErrormessage to theelectrical_components.protofile. This message is designed to represent error or warning conditions reported by microgrid electrical components. It extends a standardized error code with contextual information useful for diagnostics or vendor-specific insights.