Rename leftover uses of component_id to electrical_component_id
#398
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
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes naming by renaming leftover component_id references to electrical_component_id across sensor, microgrid, and electrical component protobufs, and updates release notes accordingly.
- Rename
MicrogridComponentIDstoMicrogridElectricalComponentIDsand its field. - Rename
source_component_id/destination_component_idtosource_electrical_component_id/destination_electrical_component_idinElectricalComponentConnection. - Rename
component_idtoelectrical_component_idinElectricalComponentTelemetryand update example comments. - Update
RELEASE_NOTES.mdto reflect these renames.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1alpha8/microgrid/sensors/sensors.proto | Updated comment example to use state_snapshots instead of states |
| proto/frequenz/api/common/v1alpha8/microgrid/microgrid.proto | Renamed MicrogridComponentIDs to MicrogridElectricalComponentIDs and its field |
| proto/frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto | Renamed connection and telemetry fields to use electrical_component_id and updated comments |
| RELEASE_NOTES.md | Added entries for field and message renames |
Comments suppressed due to low confidence (3)
RELEASE_NOTES.md:16
- Reference uses 'ElectricalComponentConnections' (plural), but the actual message is named 'ElectricalComponentConnection' (singular).
- `ElectricalComponentConnections.source_component_id` has been renamed to `ElectricalComponentConnections.source_electrical_component_id`
RELEASE_NOTES.md:17
- Reference uses 'ElectricalComponentConnections' (plural), but the actual message is named 'ElectricalComponentConnection' (singular).
- `ElectricalComponentConnections.destination_component_id` has been renamed to `ElectricalComponentConnections.destination_electrical_component_id`
RELEASE_NOTES.md:19
- Inconsistent casing: the message is 'MicrogridComponentIDs' with capital 'IDs'. Update release notes to match the exact type names.
- `microgrid.MicrogridComponentIds` has been renamed to `microgrid.MicrogridElectricalComponentIds`.
proto/frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto
Outdated
Show resolved
Hide resolved
The following changes have been made to the proto file `electrical_components.proto`: - `ElectricalComponentConnections.source_component_id` has been renamed to `ElectricalComponentConnections.source_electrical_component_id` - `ElectricalComponentConnections.destination_component_id` has been renamed to `ElectricalComponentConnections.destination_electrical_component_id` - `ElectricalComponentStateSnapshot.component_id` has been renamed to `ElectricalComponentStateSnapshot.electrical_component_id` Additionally, a few documentation comments have been updated to reflect the change from "component" to "electrical component". Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
395_electrical_component_rename
branch
from
97f5789 to
6fb6c43
Compare
llucax
previously approved these changes
Jul 9, 2025
Contributor
llucax
left a comment
llucax
left a comment
There was a problem hiding this comment.
Comments are minor, so approving.
tiyash-basu-frequenz
force-pushed
the
395_electrical_component_rename
branch
from
6fb6c43 to
62522a0
Compare
Signed-off-by: Tiyash Basu <[email protected]>
Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
395_electrical_component_rename
branch
from
62522a0 to
7a02426
Compare
llucax
approved these changes
Jul 9, 2025
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 #395