Skip to content

Commit 1263fe4

Browse files
committed
feat(api): Update Frequenz Assets API to v1alpha8 with new naming conventions
This release introduces breaking changes, including renaming RPC methods and message types to include "Electrical" for clarity. Dependencies have been updated for compatibility with the latest API specifications. Migration steps are provided for client code adjustments. Signed-off-by: eduardiazf <eduardiazf@gmail.com>
1 parent bee3053 commit 1263fe4

1 file changed

Lines changed: 42 additions & 1 deletion

File tree

RELEASE_NOTES.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,52 @@
22

33
## Summary
44

5+
This release updates the Frequenz Assets API to align with the new naming conventions and the latest version of the common API (v1alpha8). The changes include renaming RPC methods and message types to be more explicit about electrical components, as well as updating dependencies to ensure compatibility with the latest API specifications.
56

67
## Upgrading
78

8-
- Update the `frequenz-api-common` dependency
9+
⚠️ **Breaking Changes** - This release contains API changes that will require updates to client code:
10+
11+
### API Changes
12+
13+
1. **RPC Method Renaming** - All RPC methods related to microgrid components have been renamed to explicitly include "Electrical" in their names:
14+
- `ListMicrogridComponents``ListMicrogridElectricalComponents`
15+
- `ListMicrogridComponentConnections``ListMicrogridElectricalComponentConnections`
16+
17+
2. **Message Type Renaming** - Corresponding request and response message types have also been renamed:
18+
- `ListMicrogridComponentsRequest``ListMicrogridElectricalComponentsRequest`
19+
- `ListMicrogridComponentsResponse``ListMicrogridElectricalComponentsResponse`
20+
- `ListMicrogridComponentConnectionsRequest``ListMicrogridElectricalComponentConnectionsRequest`
21+
- `ListMicrogridComponentConnectionsResponse``ListMicrogridElectricalComponentConnectionsResponse`
22+
23+
3. **Common API Update** - Proto imports have been updated from `frequenz.api.common.v1` to `frequenz.api.common.v1alpha8`. This affects:
24+
- `frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponent`
25+
- `frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentCategory`
26+
- `frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentConnection`
27+
- `frequenz.api.common.v1alpha8.microgrid.Microgrid`
28+
29+
### Migration Steps
30+
31+
1. Update your `frequenz-api-common` dependency to v1alpha8 or later
32+
2. Update all RPC method calls to use the new `*ElectricalComponent*` naming
33+
3. Update all message type references to match the new naming convention
34+
4. Update proto imports from `v1` to `v1alpha8` for common API types
35+
5. Regenerate your protobuf stubs with the updated proto files
36+
37+
### Dependency Updates
38+
39+
- Updated `protobuf` and `grpcio` versions for improved compatibility
40+
- Updated `frequenz-api-common` submodule to the latest commit
41+
- Updated development dependencies including `pydoclint` (0.6.0 → 0.6.6) and various patch-level updates
942

1043
## New Features
1144

45+
This release focuses primarily on alignment with the new naming conventions and API standards. The core functionality remains the same, with the following service methods available:
46+
47+
- `GetMicrogrid` - Fetch details about a specific microgrid
48+
- `ListMicrogridElectricalComponents` - List electrical components for a specific microgrid with optional filtering by component IDs and categories
49+
- `ListMicrogridElectricalComponentConnections` - List connections between electrical components in a microgrid
50+
51+
## Bug Fixes
1252

53+
No significant bug fixes in this release. The changes are primarily focused on API alignment and naming consistency.

0 commit comments

Comments
 (0)