Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,34 @@

## Summary

<!-- Here goes a general summary of what this release is about -->
This release introduces the new `v1alpha8` version of the API, which includes several breaking changes compared to `v1alpha7`. The changes focus on improving consistency and clarity by renaming several symbols and removing unused components.

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
- A new package `frequenz.api.common.v1alpha8` has been introduced, containing the following breaking changes from `v1alpha7`.

## New Features
- Removed:

- A new package `frequenz.api.common.v1alpha8` has been added. It has the following changes when compared to `frequenz.api.common.v1alpha7`:
- `electrical_components.Fuse` has been removed.
- `InverterType.INVERTER_TYPE_WIND_TURBINE` has been removed.
- `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`
- `microgrid.MicrogridComponentIds` has been renamed to `microgrid.MicrogridElectricalComponentIds`.
- `MicrogridComponentIDs.component_ids` has been renamed to `MicrogridElectricalComponentIds.electrical_component_ids`.
- `electrical_components.VoltageTransformer` has been renamed to `electrical_components.PowerTransformer`, to make the name more consistent with the underlying concept.
- `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` has been renamed to `ElectricalComponentCategorySpecificInfo.kind.power_transformer`, to make the name more consistent with the underlying concept.
- `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` has been renamed to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER`, to make the name more consistent with the underlying concept.
- The `type` package has been renamed to `types`, to avoid using reserved keywords in programming languages.
+ `electrical_components.Fuse`
+ `InverterType.INVERTER_TYPE_WIND_TURBINE`

- Renamed several symbols to increase consistency and clarity:

## Bug Fixes
+ `microgrid`:

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
* `MicrogridComponentIds` to `MicrogridElectricalComponentIds`
* `MicrogridComponentIDs.component_ids` to `MicrogridElectricalComponentIds.electrical_component_ids`

+ `electrical_components`:

* `ElectricalComponentConnections.source_component_id` to `ElectricalComponentConnections.source_electrical_component_id`
* `ElectricalComponentConnections.destination_component_id` to `ElectricalComponentConnections.destination_electrical_component_id`
* `ElectricalComponentStateSnapshot.component_id` to `ElectricalComponentStateSnapshot.electrical_component_id`
* Transformer-related terms are renamed to align them with power transformers, which are more commonly used in electrical engineering:
* `electrical_components.VoltageTransformer` to `electrical_components.PowerTransformer`
* `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` to `ElectricalComponentCategorySpecificInfo.kind.power_transformer`
* `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER`

+ `types`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be type, we can fix it in the GitHub release notes at least.


* The whole package has been renamed to `types` to avoid using reserved keywords in programming languages.