Improve numbering in enums ElectricalComponentCategory and Metric
#336
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
This commit removes the unnecessary gap in numbering in the `ElectricalComponentCategory` enum in the `electrical_components.proto` file. Signed-off-by: Tiyash Basu <[email protected]>
This commit fixes gaps in the metric enum numbers in the `metric_sample.proto` file. Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes gaps in the numeric values of two protobuf enums to create contiguous value ranges.
- Renumbered variants in
ElectricalComponentCategoryto eliminate an unused value. - Renumbered variants in
Metricto eliminate gaps in the sequence. - Updated release notes to document the enum renumbering.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Shifted enum values down by one for several categories to close a numbering gap. |
| proto/frequenz/api/common/v1/metrics/metric_sample.proto | Adjusted enum values for reactive energy, battery, and sensor metrics to remove gaps. |
| RELEASE_NOTES.md | Noted the removal of enum gaps for ElectricalComponentCategory and Metric. |
Comments suppressed due to low confidence (2)
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto:51
- Renumbering existing enum values is a breaking change for any stored or transmitted data. Consider reserving the old value (8) or adding a new enum version to maintain backward compatibility.
ELECTRICAL_COMPONENT_CATEGORY_CRYPTO_MINER = 7;
proto/frequenz/api/common/v1/metrics/metric_sample.proto:142
- Changing the numeric identifiers of existing metrics can break clients that rely on these values. It’s safer to reserve the old numbers (69/70) or bump to a new enum version rather than renumber in place.
METRIC_AC_REACTIVE_ENERGY_PHASE_2 = 68;
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.
closes #253
closes #254