Skip to content

Commit 1190207

Browse files
committed
Update release notes
Signed-off-by: cwasicki <[email protected]>
1 parent d2a98f6 commit 1190207

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

RELEASE_NOTES.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,27 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release introduces the initial version of the Reporting API client with support for
6+
retrieving single metric historical data for a single component.
67

78
## Upgrading
89

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

1112
## New Features
1213

13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
* Introducing the initial version of the Reporting API client, streamlined for
15+
retrieving single metric historical data for a single component. It incorporates
16+
pagination handling and utilizes a wrapper data class that retains the raw
17+
protobuf response while offering transformation capabilities limited here
18+
to generators of structured data representation via named tuples.
19+
20+
* Current limitations include a single metric focus with plans for extensibility,
21+
ongoing development for states and bounds integration, as well as support for
22+
service-side features like resampling, streaming, and formula aggregations.
23+
24+
* Code examples are provided to guide users through the basic usage of the client.
25+
1426

1527
## Bug Fixes
1628

0 commit comments

Comments
 (0)