Skip to content

Commit 0ba57bf

Browse files
committed
docs: update RELEASE_NOTES.md for Assets API client
- Document new features, breaking changes, and dependencies - Add upgrade instructions and CLI usage details Signed-off-by: eduardiazf <[email protected]>
1 parent 0ce0ba1 commit 0ba57bf

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

RELEASE_NOTES.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,44 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release introduces a complete Assets API client with CLI support for interacting with Frequenz microgrid assets, including comprehensive error handling and type safety.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
**Breaking Changes:**
10+
11+
- Removed deprecated `delete_me` function
12+
- Added new required dependencies: `frequenz-api-assets`, `frequenz-api-common`, `frequenz-client-base`, `grpcio`
13+
14+
**CLI Support:**
15+
Install with `pip install "frequenz-client-assets[cli]"` for command-line functionality.
1016

1117
## New Features
1218

13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
19+
**Assets API Client:**
20+
21+
- Complete gRPC client for Frequenz Assets API
22+
- Extends `BaseApiClient` for authentication and connection management
23+
- `get_microgrid_details()` method for retrieving microgrid information
24+
25+
**Command-Line Interface:**
26+
27+
- `python -m frequenz.client.assets microgrid <id>` command
28+
- Environment variable support for API credentials
29+
- JSON output formatting
30+
31+
**Type System:**
32+
33+
- `Microgrid`, `DeliveryArea`, and `Location` data classes
34+
- Protobuf integration with proper type safety
35+
36+
**Exception Handling:**
37+
38+
- Custom exception hierarchy (`AssetsApiError`, `NotFoundError`, `AuthenticationError`, `ServiceUnavailableError`)
39+
- JSON serialization support for error responses
1440

1541
## Bug Fixes
1642

17-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
43+
- Improved dependency management with optional dependency groups
44+
- Enhanced gRPC error handling and type safety
45+
- Cleaned up deprecated code

0 commit comments

Comments
 (0)