Skip to content

Commit efcf9e2

Browse files
committed
Update release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 5127318 commit efcf9e2

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

RELEASE_NOTES.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,13 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release is a major breaking change, as we jump to the API specification version 0.17.x, which introduces big and fundamental breaking changes. This also starts using the `v1` namespace in `frequenz-api-common`, which also introduces major breaking changes. It would be very hard to detail all the API changes here, please refer to the [Microgrid API releases](https://github.com/frequenz-floss/frequenz-api-microgrid/releases) and [Common API releases](https://github.com/frequenz-floss/frequenz-api-common/releases).
66

77
## Upgrading
88

9-
- Now component and microgrid IDs are wrapped in new classes: `ComponentId` and `MicrogridId` respectively.
9+
- `MicrogridApiClient`:
1010

11-
These classes provide type safety and prevent accidental errors by:
12-
13-
- Making it impossible to mix up microgrid and component IDs (equality comparisons between different ID types always return false).
14-
- Preventing accidental math operations on IDs.
15-
- Providing clear string representations for debugging (MID42, CID42).
16-
- Ensuring proper hash behavior in collections.
17-
18-
To migrate you just need to wrap your `int` IDs with the appropriate class: `0` -> `ComponentId(0)` / `MicrogridId(0)`.
11+
* The client now follows the v0.17 API names, so most methods changed names and signatures.
1912

2013
## New Features
2114

0 commit comments

Comments
 (0)