v0.1.0

Frequenz Assets API Release Notes

Summary

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.

Upgrading

⚠️ Breaking Changes - This release contains API changes that will require updates to client code:

API Changes

1. RPC Method Renaming - All RPC methods related to microgrid components have been renamed to explicitly include "Electrical" in their names:

   • ListMicrogridComponents → ListMicrogridElectricalComponents
   • ListMicrogridComponentConnections → ListMicrogridElectricalComponentConnections

2. Message Type Renaming - Corresponding request and response message types have also been renamed:

   • ListMicrogridComponentsRequest → ListMicrogridElectricalComponentsRequest
   • ListMicrogridComponentsResponse → ListMicrogridElectricalComponentsResponse
   • ListMicrogridComponentConnectionsRequest → ListMicrogridElectricalComponentConnectionsRequest
   • ListMicrogridComponentConnectionsResponse → ListMicrogridElectricalComponentConnectionsResponse

3. Common API Update - Proto imports have been updated from frequenz.api.common.v1 to frequenz.api.common.v1alpha8. This affects:

   • frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponent
   • frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentCategory
   • frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentConnection
   • frequenz.api.common.v1alpha8.microgrid.Microgrid

Dependency Updates

• Updated protobuf and grpcio versions for improved compatibility
• Updated frequenz-api-common submodule to the latest commit
• Updated development dependencies including pydoclint (0.6.0 → 0.6.6) and various patch-level updates

New Features

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:

• GetMicrogrid - Fetch details about a specific microgrid
• ListMicrogridElectricalComponents - List electrical components for a specific microgrid with optional filtering by component IDs and categories
• ListMicrogridElectricalComponentConnections - List connections between electrical components in a microgrid

Bug Fixes

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

What's Changed

• Bump the minor group with 5 updates by @dependabot[bot] in #16
• build(deps): Bump the patch group across 1 directory with 8 updates by @dependabot[bot] in #22
• Bump pydoclint from 0.6.0 to 0.6.6 by @dependabot[bot] in #18
• chore(submodules): update frequenz-api-common submodule to latest commit by @sandovalrr in #23
• chore(submodules): update frequenz-api-common submodule to specific commit ebf585f by @sandovalrr in #32
• chore(submodules): update frequenz-api-common submodule to specific commit 0e45c6d by @sandovalrr in #33
• feat(v1alpha8): Update proto imports to v1alpha8 for microgrid components in assets.proto by @sandovalrr in #37

New Contributors

• @dependabot[bot] made their first contribution in #16

Full Changelog: v0.0.2...v0.1.0

v0.0.2

Frequenz Assets API Release Notes

Summary

Adjusted the RPC names to align with the new naming convention, and updated the frequenz-api-common dependency.

Upgrading

• Update the frequenz-api-common dependency

New Features

• Renamed ListMicrogridComponents to ListMicrogridElectricalComponents and ListMicrogridComponentConnections to ListMicrogridElectricalComponentConnections.

What's Changed

• docs: update RELEASE_NOTES with template by @sandovalrr in #10
• Upgrade to repo-config v0.13.2 by @llucax in #14
• refactor: rename electrical components rpc methods to align with the new naming convention by @sandovalrr in #20

New Contributors

• @llucax made their first contribution in #14

Full Changelog: v0.0.1...v0.0.2

v0.0.1

Frequenz Assets API Release Notes

Summary

• Setup the proto files for the Assets API.
• Added the first version of the API, with the following RPCs:
  • GetMicrogrid
  • ListMicrogridComponents
  • ListMicrogridComponentConnections

Upgrading

New Features

• Added the first version of the Assets API.
• Added the proto files to the Python package.

Bug Fixes

What's Changed

• feat(assets): defined the PlatformAssets service with microgrid and component APIs by @sandovalrr in #9

New Contributors

• @sandovalrr made their first contribution in #9

Full Changelog: https://github.com/frequenz-floss/frequenz-api-assets/commits/v0.0.1