Skip to content

Commit 0c53a33

Browse files
committed
Clear release notes
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent cbd9d41 commit 0c53a33

File tree

1 file changed

+7
-19
lines changed

1 file changed

+7
-19
lines changed

RELEASE_NOTES.md

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

33
## Summary
44

5-
This release adds enhanced filtering capabilities for gridpool orders and trades, with support for tag-based filtering and more flexible time-based queries.
5+
<!-- Here goes a general summary of what this release is about -->
66

7-
## New Features
8-
9-
* **Tag filtering for gridpool trades**: The `gridpool_trades()` method now accepts a `tag` parameter to filter trades by tag. The `GridpoolTradeFilter` dataclass has been updated accordingly.
10-
11-
* **Flexible time filtering with `DeliveryTimeFilter`**: Replaced the restrictive `delivery_period` parameter with a more flexible `delivery_time_filter` across gridpool orders and trades methods. The new `DeliveryTimeFilter` supports:
12-
- Time interval filtering with optional start/end times
13-
- Multiple delivery duration filters
14-
- More granular control over time-based queries
7+
## Upgrading
158

16-
* **New types for time filtering**: Added `Interval` and `DeliveryTimeFilter` types to support the enhanced filtering API.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1710

18-
* Support tags in CLI create-order command.
19-
20-
## Breaking Changes
11+
## New Features
2112

22-
* The `delivery_period` parameter has been replaced with `delivery_time_filter` in the following methods:
23-
- `list_gridpool_orders()`
24-
- `stream_gridpool_orders()`
25-
- `gridpool_trades()`
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
2614

27-
Note: The `create_gridpool_order()` method maintains backward compatibility by keeping both parameters.
15+
## Bug Fixes
2816

29-
* Updated API imports from v1 to v1alpha8 for common types.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)