Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reset release notes after release v0.1.3 #67

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 3 additions & 16 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,16 @@

## Summary

Key improvements of this release include a clear a distinction between Order and Trade in the protobuf definitions, improved handling of delivery period, gRPC error handling in the client and unit tests for the client types and functions.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

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

## New Features

* Make a distinction between Order and Trade in the protobuf definitions
* Introduction of new endpoints to retrieve gridpool trades
* Addition of new definitions and support for trade state filters and streaming
* Refactor DeliveryPeriod to take in a timedelta duration attribute instead of the DeliveryDuration Enum type
* Public trades renamed from public_trade_lists to public trades and all _lists suffixes removed
* Remove ORDER_EXECUTION_OPTION_NONE from OrderExecutionOption
* Add unit tests for the client types and functions
* Add error handling in the client for the gRPC errors that could be raised by the service

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

## Bug Fixes

* Remove `frequenz-api-common` files now that dependency conflict is solved
* Fix DeliveryArea from and to pb methods
* Use HasFields method on protobuf messages
* Make the `DeliveryPeriod` and all `Filter` types hashable
* Force all timestamps to be timezone aware and UTC
* Refactor some protofub timestamps that were falsly returning None values in the client
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
Loading