Skip to content

Commit 27fedfd

Browse files
Rename category type field in ElectricalComponent
This commit renames the folowing: - `ComponentCatgoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo` - `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` These renames make the entity names better reflect their purpose. Signed-off-by: Tiyash Basu <[email protected]>
1 parent 8f8fabb commit 27fedfd

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@
2929
- Renamed electrical component category `COMPONENT_CATEGORY_GRID` to `ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT` to clarify its meaning. Note that the change in the enum change is a part of a larger refactoring of the electrical component category enum.
3030
- The oneof variant `ComponentCategoryMetadataVariant.metadata.grid` has been renamed to `ElectricalComponentCategorySpecificInfo.info.grid_connection_point` to better reflect its purpose.
3131
- A new inverter type `INVERTER_TYPE_WIND_TURBINE` has been added to the `InverterType` enum.
32+
- Renamed `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`.
33+
- Renamed field `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` to better reflect its purpose.
3234

3335
## Bug Fixes
3436

proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,8 +349,8 @@ message MetricConfigBounds {
349349
}
350350

351351
// Metadata specific to a microgrid component.
352-
message ElectricalComponentCategoryMetadataVariant {
353-
oneof metadata {
352+
message ElectricalComponentCategorySpecificInfo {
353+
oneof kind {
354354
frequenz.api.common.v1.microgrid.electrical_components.Battery battery = 1;
355355
frequenz.api.common.v1.microgrid.electrical_components.EvCharger
356356
ev_charger = 2;
@@ -379,7 +379,7 @@ message ElectricalComponent {
379379
ElectricalComponentCategory category = 4;
380380

381381
// The metadata specific to the component category type.
382-
ElectricalComponentCategoryMetadataVariant category_type = 5;
382+
ElectricalComponentCategorySpecificInfo category_specific_info = 5;
383383

384384
// The component manufacturer.
385385
string manufacturer = 6;

0 commit comments

Comments
 (0)