Skip to content

Commit 0510cf3

Browse files
committed
Reset release notes
Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 232b3f3 commit 0510cf3

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

RELEASE_NOTES.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,16 @@
22

33
## Summary
44

5-
This release includes a new feature for pagination support in the dispatch list request as well as usage of the base-client for setting up the channel and client configuration.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
- The `Client.list()` function now yields a `list[Dispatch]` representing one page of dispatches
10-
- `Client.__init__` no longer accepts a `grpc_channel` argument, instead a `server_url` argument is required.
11-
- For the dispatch-cli client, `DISPATCH_API_PORT` and `DISPATCH_API_HOST` environment variables have been replaced with `DISPATCH_API_URL` which should be a full URL including the protocol (e.g. `grpc://fz-0004.frequenz.io:50051`)
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1210

1311
## New Features
1412

15-
- Pagination support in the dispatch list request.
16-
- `Client.__init__`:
17-
- Has a new parameter `connect` which is a boolean that determines if the client should connect to the server on initialization.
18-
- Automatically sets up the channel for encrypted TLS communication.
19-
- A new method `stream()` to receive dispatch events in real-time.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
16+
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)