|
2 | 2 |
|
3 | 3 | ## Summary |
4 | 4 |
|
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. |
| 5 | +<!-- Here goes a general summary of what this release is about --> |
6 | 6 |
|
7 | 7 | ## Upgrading |
8 | 8 |
|
9 | | -- A new package `frequenz.api.common.v1alpha8` has been introduced, containing the following breaking changes from `v1alpha7`. |
| 9 | +<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> |
10 | 10 |
|
11 | | -- Removed: |
| 11 | +## New Features |
12 | 12 |
|
13 | | - + `electrical_components.Fuse` |
14 | | - + `InverterType.INVERTER_TYPE_WIND_TURBINE` |
| 13 | +<!-- Here goes the main new features and examples or instructions on how to use them --> |
15 | 14 |
|
16 | | -- Renamed several symbols to increase consistency and clarity: |
| 15 | +## Bug Fixes |
17 | 16 |
|
18 | | - + `microgrid`: |
19 | | - |
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. |
| 17 | +<!-- Here goes notable bug fixes that are worth a special mention or explanation --> |
0 commit comments