# Dispatch Highlevel Interface Release Notes

## Summary

## Upgrading

* The method `Dispatch.running(type: str)` was replaced with the property `Dispatch.started: bool`.
* The SDK dependency was widened to allow versions up to (excluding) v1.0.0-rc1500

## New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

* Fixed a crash when reading a Dispatch with frequency YEARLY.

# Dispatch Highlevel Interface Release Notes

## Summary

* Updates lots of dependencies and through those gets a few new features:
 * `start_immediately` when creating dispatches is now supported.
 * `http2 keepalive` is now supported and enabled by default.
 * Some bugfixes from the channels & sdk libraries. are now included.

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

* Fixed a crash in the `DispatchManagingActor` when dispatches shared an equal start time.

# Dispatch Highlevel Interface Release Notes

## Summary

This is a hot fix for recurrence not working when even one `by-*` field isn't explicitly set.

# Dispatch Highlevel Interface Release Notes

## Summary

* `frequenz-sdk` dependency has been extended to include version `1.0.0-rc1000`.

# Dispatch Highlevel Interface Release Notes

## Summary

* This fixes a crash when the `YEARLY` frequency is used in a dispatch.

# Dispatch Highlevel Interface Release Notes

## Summary

<!-- Here goes a general summary of what this release is about -->

## Upgrading

* `Dispatcher.running_state_change` now also sends a message when the duration specified in the dispatch has passed. If no duration is specified, no STOPPED message will be sent.

## New Features

* We now provide the `DispatchManagingActor` class, a class to manage actors based on incoming dispatches.

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

# Dispatch Highlevel Interface Release Notes

## Summary

<!-- Here goes a general summary of what this release is about -->

## Upgrading

- The dispatch high level interface now depends on `frequenz-sdk` version `v1.0.0-rc900`.
- We are now using the version `0.6.0` of the underlying `frequenz-client-dispatch` client library.
- The init parameter of the `Dispatcher` class has been changed to accept a `server_url` instead.

## New Features

* Using the new dispatch client, we now have support for pagination in the dispatch list request.
* The new client version also supports streaming, however it is not yet used internally in the high level interface.

## Bug Fixes

- Fix documentation cross-linking to the `frequenz-client-dispatch` package.

# Dispatch Highlevel Interface Release Notes

## Upgrading

* An API key for authorization must now be passed to the client.

# Dispatch Highlevel Interface Release Notes

## Summary

This is the first release of the highlevel dispatch interface!

## Upgrading

* `Dispatcher.ready_to_execute()` was renamed to `Dispatcher.running_status_change()`

## New Features

* Introduced new class `Dispatch` (based on the client class) that contains useful functions and extended information about the received dispatch.
* `Dispatcher.client` was added to provide an easy access to the client for updating, deleting and creating dispatches