Skip to content

Add v1alpha19 API and rename ComponentTelemetryStreamFilter#347

Merged
tiyash-basu-frequenz merged 3 commits intofrequenz-floss:v0.x.xfrom
tiyash-basu-frequenz:feature
Jul 17, 2025
Merged

Add v1alpha19 API and rename ComponentTelemetryStreamFilter#347
tiyash-basu-frequenz merged 3 commits intofrequenz-floss:v0.x.xfrom
tiyash-basu-frequenz:feature

Conversation

@tiyash-basu-frequenz
Copy link
Copy Markdown
Contributor

No description provided.

Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
@tiyash-basu-frequenz tiyash-basu-frequenz added this to the v0.19.0 milestone Jul 14, 2025
@tiyash-basu-frequenz tiyash-basu-frequenz self-assigned this Jul 14, 2025
Copilot AI review requested due to automatic review settings July 14, 2025 09:57
@tiyash-basu-frequenz tiyash-basu-frequenz requested a review from a team as a code owner July 14, 2025 09:57
@github-actions github-actions Bot added part:docs Affects the documentation part:protobuf Affects the protocol buffer definition files labels Jul 14, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces the v1alpha19 preview API for the Frequenz Microgrid service and updates related naming in the proto definitions and release notes.

  • Adds a new microgrid.proto under v1alpha19 with updated RPCs and messages.
  • Renames the nested telemetry stream filter type and adjusts corresponding comments.
  • Updates RELEASE_NOTES.md to reference v1alpha19 and adjust upgrade instructions.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
proto/frequenz/api/microgrid/v1alpha19/microgrid.proto Added new v1alpha19 package with updated service and messages
RELEASE_NOTES.md Updated version references and upgrade instructions
Comments suppressed due to low confidence (3)

proto/frequenz/api/microgrid/v1alpha19/microgrid.proto:71

  • The comment mentions filtering by both sensor IDs and categories, but ListSensorRequest only provides a sensor_ids field. Please update or remove the category reference in the docs to match the actual request parameters.
  //

proto/frequenz/api/microgrid/v1alpha19/microgrid.proto:352

  • [nitpick] The request message is named ListSensorRequest while the RPC is ListSensors, and other list RPCs use plural in the request (ListElectricalComponentsRequest). Consider renaming this to ListSensorsRequest for consistency.
message ListSensorRequest {

RELEASE_NOTES.md:23

  • The section header is present but the dependency update details that were in earlier releases have been removed. Please re-add any required dependency upgrade notes (e.g., protobuf, grpcio minimum versions) under this section.
## Upgrading to the `v0.19.0` release

Comment thread proto/frequenz/api/microgrid/v1alpha19/microgrid.proto Outdated
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
This commit renames the `ComponentTelemetryStreamFilter` message to
`ElectricalComponentTelemetryStreamFilter` in the `v1alpha19` API.

Additionall, this commit also updates the `RELEASE_NOTES.md` file to
reflect the changes made in this release so far, including the
introduction of the new `v1alpha19` API and the renaming of the
telemetry stream filter.

Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
@tiyash-basu-frequenz tiyash-basu-frequenz requested a review from a team as a code owner July 14, 2025 11:33
@github-actions github-actions Bot added part:tests Affects the unit, integration and performance (benchmarks) tests part:python Affects the Python bindings labels Jul 14, 2025
Copy link
Copy Markdown
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

God dammit, how did we missed this one! 😆

@tiyash-basu-frequenz tiyash-basu-frequenz added this pull request to the merge queue Jul 17, 2025
Merged via the queue into frequenz-floss:v0.x.x with commit 9dcdba3 Jul 17, 2025
7 checks passed
@tiyash-basu-frequenz tiyash-basu-frequenz deleted the feature branch July 17, 2025 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation part:protobuf Affects the protocol buffer definition files part:python Affects the Python bindings part:tests Affects the unit, integration and performance (benchmarks) tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants