Update release notes

Signed-off-by: Leandro Lucarella <[email protected]>
frequenz-floss · Oct 7, 2024 · 62c2583 · 62c2583
1 parent 01e066a
commit 62c2583
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -2,12 +2,13 @@
 
 ## Summary
 
-<!-- Here goes a general summary of what this release is about -->
+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).
 
 ## Upgrading
 
 - `ApiClient`:
 
+    * The client now follows the v0.17 API names, so most methods changed names and signatures.
     * The class was renamed to `MicrogridApiClient`.
     * The `api` attribute was renamed to `stub`.
     * The constructor parameter `channel_options` was renamed to `channels_defaults` to match the name used in `BaseApiClient`.