Releases: frequenz-floss/frequenz-api-assets
Release list
v0.4.0
Frequenz Assets API Release Notes
Upgrading
- The minimum
frequenz-api-commondependency version is now0.8.11. MarketTopologyRelation.market_locationhas been renamed tomarket_location_refto match the new message name in the common API.
What's Changed
- chore: cleanup release notes by @sandovalrr in #108
- chore(deps-dev): Bump the patch group with 2 updates by @dependabot[bot] in #110
- chore(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 1.0.4 to 1.0.5 in the compatible group by @dependabot[bot] in #109
- chore(deps): Bump actions/checkout from 6.0.3 to 7.0.0 by @dependabot[bot] in #111
- chore(deps-dev): Bump pydoclint from 0.8.5 to 0.9.0 by @dependabot[bot] in #113
- chore(deps-dev): Bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #112
- chore(deps): Bump the compatible group with 3 updates by @dependabot[bot] in #114
- chore(deps-dev): Bump frequenz-repo-config from 0.17.0 to 0.18.0 in the repo-config group across 1 directory by @dependabot[bot] in #102
- chore(deps): bump the compatible group with 2 updates by @dependabot[bot] in #115
- chore(deps-dev): bump pydoclint from 0.9.0 to 0.9.1 by @dependabot[bot] in #116
- Bump frequenz-api-common to v0.8.11 by @llucax in #117
Full Changelog: v0.3.0...v0.4.0
v0.3.0
Frequenz Assets API Release Notes
Summary
This release renames MarketLocationSelector to MarketLocation and fixes
packaging for the generated Platform Assets API modules.
Upgrading
- Rename
MarketLocationSelectortoMarketLocation. - The legacy
frequenz.api.assets.v1package was removed. - Use
frequenz.api.platformassets.v1alpha1for the generated API package.
New Features
Bug Fixes
- Include the generated runtime modules for
frequenz.api.platformassets.v1alpha1in wheels.
What's Changed
- chore: cleanup release notes by @sandovalrr in #96
- v1alpha1 stuctural changes and documentation improvements by @thomas-nicolai-frequenz in #97
- New ListGridpoolAssignments RPC by @thomas-nicolai-frequenz in #98
- chore(deps): Bump the compatible group with 4 updates by @dependabot[bot] in #100
- chore(deps-dev): Bump the minor group with 2 updates by @dependabot[bot] in #101
- chore(deps-dev): Bump types-markdown from 3.10.2.20260508 to 3.10.2.20260518 by @dependabot[bot] in #105
- chore(deps-dev): Bump pydoclint from 0.8.3 to 0.8.5 by @dependabot[bot] in #106
- Added ListGridpoolEnergySchedules and ListMicrogridSensors RPCs by @thomas-nicolai-frequenz in #99
- refactor!: remove legacy assets v1 API by @sandovalrr in #107
Full Changelog: v0.2.1...v0.3.0
v0.2.1
Frequenz Assets API Release Notes
Summary
This release adds ListMicrogrids and GetGridpool to
frequenz.api.platformassets.v1alpha1.
Upgrading
frequenz.api.platformassets.v1alpha1.PlatformAssetsServicenow includes
ListMicrogrids.frequenz.api.platformassets.v1alpha1includes theGetGridpool
request/response messages and RPC.frequenz.api.platformassets.v1alpha1remains a separate versioned package
with the renamedPlatformAssetsService.
New Features
- Add the
ListMicrogridsRPC to thePlatformAssetsServiceservice. - Add the
GetGridpoolRPC to thePlatformAssetsServiceservice.
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
- chore(submodules): update frequenz-api-common submodule to latest version by @sandovalrr in #45
- build(deps): Bump the compatible group with 2 updates by @dependabot[bot] in #36
- build(deps): Bump the patch group across 1 directory with 4 updates by @dependabot[bot] in #43
- build(deps): Bump pydoclint from 0.6.6 to 0.7.3 by @dependabot[bot] in #42
- Add repo-config auto-migration workflow by @llucax in #65
- build(deps): Bump the compatible group across 1 directory with 3 updates by @dependabot[bot] in #67
- build(deps): Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #53
- build(deps): Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #49
- build(deps): Bump actions/download-artifact from 4 to 6 by @dependabot[bot] in #48
- build(deps-dev): Bump the patch group across 1 directory with 2 updates by @dependabot[bot] in #68
- build(deps): Bump actions/checkout from 3 to 6 by @dependabot[bot] in #57
- build(deps-dev): Bump mkdocstrings from 0.30.1 to 1.0.4 by @dependabot[bot] in #73
- build(deps): Bump protobuf from 6.31.1 to 6.33.5 by @dependabot[bot] in #75
- build(deps-dev): Bump black from 25.1.0 to 26.3.1 by @dependabot[bot] in #74
- build(deps-dev): Bump frequenz-repo-config from 0.13.5 to 0.17.0 in the repo-config group across 1 directory by @dependabot[bot] in #70
- chore(deps): Bump the compatible group across 1 directory with 5 updates by @dependabot[bot] in #81
- chore(deps-dev): Bump mkdocstrings-python from 1.16.12 to 2.0.3 by @dependabot[bot] in #71
- chore(deps-dev): Bump pytest from 8.4.2 to 9.0.3 by @dependabot[bot] in #76
- chore(deps-dev): Bump pydoclint from 0.7.3 to 0.8.3 by @dependabot[bot] in #58
- chore(deps): Bump actions/create-github-app-token from 2.2.1 to 3.1.1 by @dependabot[bot] in #78
- chore(deps-dev): Bump mkdocs-gen-files from 0.5.0 to 0.6.1 by @dependabot[bot] in #72
- Fix dependabot grpcio/protobuf updates by @llucax in #83
- chore(deps-dev): Bump the minor group across 1 directory with 5 updates by @dependabot[bot] in #86
- chore(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 0d0d77eac3b54799f31f25a1060ef2c6ebdf9299 to e4d0b2ef8f5a1612d7827f3abaef17c931d2b946 by @dependabot[bot] in #85
- chore(deps): Bump frequenz-floss/gh-action-setup-git from 16952aac3ccc01d27412fe0dea3ea946530dcace to f9d86a01228ee1cadaac5224d4d7626f1eb23f90 by @dependabot[bot] in #87
- chore(deps-dev): Bump mypy from 1.17.1 to 2.0.0 by @dependabot[bot] in #89
- chore(deps-dev): Bump nox from 2025.5.1 to 2026.4.10 by @dependabot[bot] in #90
- chore(deps-dev): Bump setuptools-scm from 8.3.1 to 10.0.5 by @dependabot[bot] in #92
- chore(deps-dev): Bump pylint from 3.3.8 to 4.0.5 by @dependabot[bot] in #94
- chore(deps-dev): Bump setuptools from 80.9.0 to 82.0.1 by @dependabot[bot] in #93
- chore(deps): Bump the grpc-compatible group with 2 updates by @dependabot[bot] in #88
- chore(deps-dev): Bump isort from 6.0.1 to 8.0.1 by @dependabot[bot] in #91
- ListMicrogridElectricalComponentConnectionsRequest header doc changes by @thomas-nicolai-frequenz in #95
- feat(assets): add ListMicrogrids, GetGridpool RPC and associated request/response messages by @sandovalrr in #55
New Contributors
- @dependabot[bot] made their first contribution in #16
- @thomas-nicolai-frequenz made their first contribution in #95
Full Changelog: v0.0.2...v0.2.1
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
API Changes
-
RPC Method Renaming - All RPC methods related to microgrid components have been renamed to explicitly include "Electrical" in their names:
ListMicrogridComponents→ListMicrogridElectricalComponentsListMicrogridComponentConnections→ListMicrogridElectricalComponentConnections
-
Message Type Renaming - Corresponding request and response message types have also been renamed:
ListMicrogridComponentsRequest→ListMicrogridElectricalComponentsRequestListMicrogridComponentsResponse→ListMicrogridElectricalComponentsResponseListMicrogridComponentConnectionsRequest→ListMicrogridElectricalComponentConnectionsRequestListMicrogridComponentConnectionsResponse→ListMicrogridElectricalComponentConnectionsResponse
-
Common API Update - Proto imports have been updated from
frequenz.api.common.v1tofrequenz.api.common.v1alpha8. This affects:frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentfrequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentCategoryfrequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentConnectionfrequenz.api.common.v1alpha8.microgrid.Microgrid
Dependency Updates
- Updated
protobufandgrpcioversions for improved compatibility - Updated
frequenz-api-commonsubmodule 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 microgridListMicrogridElectricalComponents- List electrical components for a specific microgrid with optional filtering by component IDs and categoriesListMicrogridElectricalComponentConnections- 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-commondependency
New Features
- Renamed
ListMicrogridComponentstoListMicrogridElectricalComponentsandListMicrogridComponentConnectionstoListMicrogridElectricalComponentConnections.
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
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:
GetMicrogridListMicrogridComponentsListMicrogridComponentConnections
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