Skip to content

Commit 6495891

Browse files
committed
Add release notes
Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 782bf2c commit 6495891

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

RELEASE_NOTES.md

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

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
In this release, we have made some changes to the API to improve the user experience and to fix some bugs.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
* The dispatch message was split into into metadata and data.
10+
* `microgrid_id` is required for all requests.
11+
* `id` was renamed to `dispatch_id` in all requests.
12+
* Naming conventions were updated to match API projects.
13+
* The possibility to update the `dry_run` and `type` fields was removed.
1014

1115
## New Features
1216

13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
17+
* Create and Update request now returns the new dispatch object.
18+
* Documentation about authentication and encryption was added.
1419

1520
## Bug Fixes
1621

0 commit comments

Comments
 (0)