Skip to content

Commit caf1e00

Browse files
authored
Reset release notes (#192)
Reset after release
2 parents 5af579c + 15c8947 commit caf1e00

File tree

1 file changed

+4
-22
lines changed

1 file changed

+4
-22
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,16 @@
22

33
## Summary
44

5-
In this release, we have made some changes to the API to improve the user experience and to fix some bugs.
6-
This might be the last breaking release, at least I tried hard to make it so.
7-
Fingers crossed.
8-
9-
Note: The API supporting a feature does not mean that the service or client supports it as well, just yet.
5+
<!-- Here goes a general summary of what this release is about -->
106

117
## Upgrading
128

13-
* The dispatch message was split into into metadata and data.
14-
* `microgrid_id` is required for all requests.
15-
* `id` was renamed to `dispatch_id` in all requests.
16-
* Naming conventions were updated to match API projects.
17-
* The possibility to update the `dry_run` and `type` fields was removed.
18-
* The ComponentSelector now can contain multiple component categories.
19-
* Improve description of the `EndCriteria.until` field.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
2010

2111
## New Features
2212

23-
* Create and Update request now returns the new dispatch object.
24-
* Documentation about authentication and encryption was added.
25-
* Enhanced `payload` documentation.
26-
* Add RPC streaming methods.
27-
* Add YEARLY frequency to the recurrence definition.
28-
* Add parameters for pagination and sorting.
29-
* Documentation of valid values for `count` and `interval` fields was added.
30-
* Extended `DispatchFilter` to support filtering by `recurrence` and `end_time`.
31-
* Add new field `end_time` to the `DispatchDetail`.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
3214

3315
## Bug Fixes
3416

35-
* The field `bymonthdays` the recurrence definition also supports negative values and was updated accordingly.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)