diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index c3baf309..80e5f0cb 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,14 +1,17 @@ # Frequenz Microgrid API Client Release Notes +## Summary + + + ## Upgrading -- Now component and microgrid IDs are wrapped in new classes: `ComponentId` and `MicrogridId` respectively. + + +## New Features - These classes provide type safety and prevent accidental errors by: + - - Making it impossible to mix up microgrid and component IDs (equality comparisons between different ID types always return false). - - Preventing accidental math operations on IDs. - - Providing clear string representations for debugging (MID42, CID42). - - Ensuring proper hash behavior in collections. +## Bug Fixes - To migrate you just need to wrap your `int` IDs with the appropriate class: `0` -> `ComponentId(0)` / `MicrogridId(0)`. +