Skip to content

Commit ce3c26d

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

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +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

99
- `ApiClient`:
1010

11+
* The client now follows the v0.17 API names, so most methods changed names and signatures.
1112
* The class was renamed to `MicrogridApiClient`.
1213
* The `api` attribute was renamed to `stub`.
1314
* The constructor parameter `channel_options` was renamed to `channels_defaults` to match the name used in `BaseApiClient`.

0 commit comments

Comments
 (0)