|
2 | 2 |
|
3 | 3 | ## Summary |
4 | 4 |
|
5 | | -<!-- Here goes a general summary of what this release is about --> |
| 5 | +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. |
6 | 6 |
|
7 | 7 | ## Upgrading |
8 | 8 |
|
9 | | -<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> |
| 9 | +- A new package `frequenz.api.common.v1alpha8` has been introduced, containing the following breaking changes from `v1alpha7`. |
10 | 10 |
|
11 | | -## New Features |
| 11 | +- Removed: |
12 | 12 |
|
13 | | -- A new package `frequenz.api.common.v1alpha8` has been added. It has the following changes when compared to `frequenz.api.common.v1alpha7`: |
14 | | - - `electrical_components.Fuse` has been removed. |
15 | | - - `InverterType.INVERTER_TYPE_WIND_TURBINE` has been removed. |
16 | | - - `ElectricalComponentConnections.source_component_id` has been renamed to `ElectricalComponentConnections.source_electrical_component_id` |
17 | | - - `ElectricalComponentConnections.destination_component_id` has been renamed to `ElectricalComponentConnections.destination_electrical_component_id` |
18 | | - - `ElectricalComponentStateSnapshot.component_id` has been renamed to `ElectricalComponentStateSnapshot.electrical_component_id` |
19 | | - - `microgrid.MicrogridComponentIds` has been renamed to `microgrid.MicrogridElectricalComponentIds`. |
20 | | - - `MicrogridComponentIDs.component_ids` has been renamed to `MicrogridElectricalComponentIds.electrical_component_ids`. |
21 | | - - `electrical_components.VoltageTransformer` has been renamed to `electrical_components.PowerTransformer`, to make the name more consistent with the underlying concept. |
22 | | - - `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` has been renamed to `ElectricalComponentCategorySpecificInfo.kind.power_transformer`, to make the name more consistent with the underlying concept. |
23 | | - - `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. |
24 | | - - The `type` package has been renamed to `types`, to avoid using reserved keywords in programming languages. |
| 13 | + + `electrical_components.Fuse` |
| 14 | + + `InverterType.INVERTER_TYPE_WIND_TURBINE` |
25 | 15 |
|
| 16 | +- Renamed several symbols to increase consistency and clarity: |
26 | 17 |
|
27 | | -## Bug Fixes |
| 18 | + + `microgrid`: |
28 | 19 |
|
29 | | -<!-- Here goes notable bug fixes that are worth a special mention or explanation --> |
| 20 | + * `MicrogridComponentIds` to `MicrogridElectricalComponentIds` |
| 21 | + * `MicrogridComponentIDs.component_ids` to `MicrogridElectricalComponentIds.electrical_component_ids` |
| 22 | + |
| 23 | + + `electrical_components`: |
| 24 | + |
| 25 | + * `ElectricalComponentConnections.source_component_id` to `ElectricalComponentConnections.source_electrical_component_id` |
| 26 | + * `ElectricalComponentConnections.destination_component_id` to `ElectricalComponentConnections.destination_electrical_component_id` |
| 27 | + * `ElectricalComponentStateSnapshot.component_id` to `ElectricalComponentStateSnapshot.electrical_component_id` |
| 28 | + * Transformer-related terms are renamed to align them with power transformers, which are more commonly used in electrical engineering: |
| 29 | + * `electrical_components.VoltageTransformer` to `electrical_components.PowerTransformer` |
| 30 | + * `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` to `ElectricalComponentCategorySpecificInfo.kind.power_transformer` |
| 31 | + * `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER` |
| 32 | + |
| 33 | + + `types`: |
| 34 | + |
| 35 | + * The whole package has been renamed to `types` to avoid using reserved keywords in programming languages. |
0 commit comments