v0.10.0

Frequenz Reporting API Release Notes

Summary

• The changes introduced in v0.9.0 have been reverted. frequenz.api.reporting.v1 now serves the frequenz.api.common.v1 definitions.
• A new protobuf package has been introduced, frequenz.api.reporting.v1alpha10, in which the frequenz.api.common.v1alpha8 adaptations can be found.

Upgrading

New Features

Bug Fixes

What's Changed

• Bump pydoclint from 0.6.6 to 0.7.3 by @dependabot[bot] in #129
• Bump the patch group with 4 updates by @dependabot[bot] in #126
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #122
• Bump actions/download-artifact from 4 to 5 by @dependabot[bot] in #123
• Bump the minor group across 1 directory with 6 updates by @dependabot[bot] in #131
• Bump mkdocstrings-python from 1.16.12 to 1.18.2 by @dependabot[bot] in #130
• Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #124
• Add protobuf definitions for reporting API v2 by @stefan-brus-frequenz in #133

Full Changelog: v0.9.0...v0.10.0

v0.9.0

Frequenz Reporting API Release Notes

Summary

• The frequenz-api-common dependency has been updated to v0.8.0
• The reporting API now uses v1alpha8 of the common API, which comes with some breaking changes

Upgrading

• The MicrogridComponentIDs message is now called MicrogridElectricalComponentIDs
• The ComponentData message is now called ElectricalComponentTelemetry
• The SensorData message is now called SensorTelemetry

New Features

Bug Fixes

What's Changed

• Bump the compatible group with 2 updates by @dependabot[bot] in #111
• Bump mkdocstrings[python] from 0.29.1 to 0.30.0 in the mkdocstrings group by @dependabot[bot] in #112
• Bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #115
• Remove unused pagination imports by @stefan-brus-frequenz in #120
• Update common dependency to v0.8.0, use v1alpha8 API by @stefan-brus-frequenz in #121

Full Changelog: v0.8.1...v0.9.0

v0.8.1

Frequenz Reporting API Release Notes

Summary

• Dependency versions have been bumped, see "Upgrading" for specifics
• Renaming of time filter fields, see "Upgrading" for specifics

Upgrading

• The minimum allowed version of protobuf and grpcio has been updated to 6.31.1 and 1.72.1 respectively, you might also need to bump your dependencies accordingly.
• The fields start and end in TimeFilter have been renamed to start_time and end_time respectively. Apps that implement this API should take care.
• Widen dependency range for frequenz-api-common to also support v0.8.x.

New Features

Bug Fixes

What's Changed

• Add formula syntax section to readme by @stefan-brus-frequenz in #106
• Bump the patch group with 6 updates by @dependabot[bot] in #107
• dependabot: Group grpc/protobuf updates together by @llucax in #110
• Widen dependency range for common API by @cwasicki in #114
• Update release notes by @cwasicki in #119

Full Changelog: v0.8.0...v0.8.1

v0.8.0

Frequenz Reporting API Release Notes

Summary

• Dependency versions have been bumped, see "Upgrading" for specifics
• Renaming of time filter fields, see "Upgrading" for specifics

Upgrading

• The minimum allowed version of protobuf and grpcio has been updated to 6.31.1 and 1.72.1 respectively, you might also need to bump your dependencies accordingly.
• The fields start and end in TimeFilter have been renamed to start_time and end_time respectively. Apps that implement this API should take care.

New Features

Bug Fixes

What's Changed

• Bump nox from 2024.10.9 to 2025.2.9 by @dependabot in #84
• Update to repo-config v0.13.2 by @llucax in #89
• Bump protobuf and grpcio to 6.31.1 and 1.72.1 respectively by @llucax in #100
• Bump pydoclint from 0.6.0 to 0.6.6 by @dependabot in #96
• Bump the minor group across 1 directory with 7 updates by @dependabot in #102
• Bump the patch group across 1 directory with 7 updates by @dependabot in #101
• Bump actions/checkout from 3 to 4 by @dependabot in #99
• Bump grpc-stubs from 1.53.0.5 to 1.53.0.6 by @dependabot in #98
• Bump setuptools from 75.8.0 to 80.9.0 by @dependabot in #95
• Update release notes by @stefan-brus-frequenz in #103

New Contributors

• @llucax made their first contribution in #89

Full Changelog: v0.7.0...v0.8.0

v0.7.0

Frequenz Reporting API Release Notes

Summary

• Added sensor-ID based RPCs

Upgrading

New Features

• Two new RPCs have been added to support sensor data:
  • ReceiveMicrogridSensorsDataStream
  • ReceiveAggregatedMicrogridSensorsDataStream

Bug Fixes

What's Changed

• Bump yoheimuta/action-protolint from 1.0.0 to 1.3.0 in the compatible group by @dependabot in #69
• Add RPCs for sensors by @stefan-brus-frequenz in #82
• Fix doc for end time filter by @cwasicki in #65

Full Changelog: v0.6.0...v0.7.0

v0.6.0

Frequenz Reporting API Release Notes

Summary

Upgrading

New Features

Bug Fixes

What's Changed

• Remove unused api-common-protos submodule by @stefan-brus-frequenz in #61
• Bump the required group across 1 directory with 19 updates by @dependabot in #63
• Bump actions/labeler from 4.3.0 to 5.0.0 by @dependabot in #11
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #41
• Bump the required group across 1 directory with 8 updates by @dependabot in #68
• Bump setuptools from 70.1.1 to 75.8.0 by @dependabot in #74
• Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by @dependabot in #75
• Bump docker/build-push-action from 5 to 6 by @dependabot in #72
• Bump pydoclint from 0.5.14 to 0.5.15 in the required group by @dependabot in #73
• Bump the artifacts group with 2 updates by @dependabot in #70
• Bump actions/cache from 3 to 4 by @dependabot in #71
• Bump isort from 5.13.2 to 6.0.0 by @dependabot in #79
• Bump the required group with 3 updates by @dependabot in #77
• Bump black from 24.10.0 to 25.1.0 by @dependabot in #78
• Update aggregated formula docs to reflect support for connection identifiers by @stefan-brus-frequenz in #80
• Bump the grpcio group with 2 updates by @dependabot in #76

Full Changelog: v0.5.0...v0.6.0

v0.5.0

Frequenz Reporting API Release Notes

Summary

• List* endpoints have been removed.
• MetricSourceOptions have been renamed to MetricConnections, and moved out of the filter message.

Upgrading

• Servers should remove the list endpoint implementations, clients should use the streaming endpoints.
• Metric source info can be found directly on the request, instead of in the filter object.

New Features

Bug Fixes

What's Changed

• Bump the required group across 1 directory with 11 updates by @dependabot in #46
• Remove list_* endpoints, modify metric source options & docs by @stefan-brus-frequenz in #56
• Update pinned dependency versions by @stefan-brus-frequenz in #57

Full Changelog: v0.4.0...v0.5.0

v0.4.0

Frequenz Reporting API Release Notes

Summary

• Metric source options

Upgrading

New Features

• A new field, MetricSourceOptions has been added to the StreamFilter message, allowing users to give specific sources for a given metric.
  Multiples of the same metric can exist, in which case they are "tagged" with the source they come from. The metric source options allows
  the user to specify one or multiple tags.

Bug Fixes

What's Changed

• Bump nox from 2023.4.22 to 2024.4.15 by @dependabot in #36
• Add metric source options message by @stefan-brus-frequenz in #45

Full Changelog: v0.3.0...v0.4.0

v0.3.0

Frequenz Reporting API Release Notes

Summary

• Add time filter options to the streaming request, to allow for streaming of historical data.

Upgrading

New Features

• The streaming requests now contain optional TimeFilter objects for streaming historical data.

Bug Fixes

What's Changed

• Reset release notes to template by @flora-hofmann-frequenz in #30
• Bump grpc-stubs from 1.53.0.2 to 1.53.0.5 by @dependabot in #37
• Add time filters to streaming requests by @stefan-brus-frequenz in #39

Full Changelog: v0.2.0...v0.3.0

v0.2.0

Frequenz Reporting API Release Notes

Summary

Updated frequenz-api-common dependency from v0.5.1 to v0.6.0

Upgrading

• The dependency on frequenz-api-common was upgraded to v0.6.0. The release notes of this version can be found here: https://github.com/frequenz-floss/frequenz-api-common/releases/tag/v0.6.0
• Name changes in reporting.proto:
  • Renamed SimpleAggregatedMetricSample to SimpleAggregatedMetricValue.
  • Renamed SimpleMetricSample to SimpleMetricValue.

What's Changed

• Bump actions/setup-python from 4 to 5 by @dependabot in #10
• Minor: Clarify timestamp in resampling docs by @cwasicki in #27
• Bump actions/checkout from 3 to 4 by @dependabot in #2
• Update frequenz-api-common dependency to v0.6.0 by @cyiallou in #28
• Remove template comments and empty sections from release notes by @flora-hofmann-frequenz in #29

New Contributors

• @dependabot made their first contribution in #10
• @cwasicki made their first contribution in #27
• @cyiallou made their first contribution in #28
• @flora-hofmann-frequenz made their first contribution in #29

Full Changelog: v0.1.1...v0.2.0