Skip to content

Conversation

@flora-hofmann-frequenz
Copy link
Collaborator

@flora-hofmann-frequenz flora-hofmann-frequenz commented Nov 27, 2024

This update includes MetricConnections in the request message, that comes with a breaking change in the API specs. To ensure compatibility, both the client and service must be updated simultaneously. Specifically:

  • This and later versions of the client can only be used with the latest reporting API service >=v0.7 but not with older versions of the service.
  • Older versions of the client can only be used with the reporting API service versions < v0.7 but no later versions.

@github-actions github-actions bot added part:docs Affects the documentation part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) labels Nov 27, 2024
pyproject.toml Outdated
"typing_extensions >= 4.6.1, < 5",
"grpc-stubs == 1.53.0.5",
"frequenz-api-reporting >= 0.2.0, < 0.5",
"frequenz-api-reporting >= 0.2.0, < 0.6",
Copy link
Contributor

Choose a reason for hiding this comment

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

The lower version needs to be updated where MetricConnections was introduced, otherwise this fails.

"warning": state.warnings,
"error": state.errors,
}.items():
# Skip if the category is not present
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are these comments removed?

RELEASE_NOTES.md Outdated
## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
* Update to use frequenz-api-reporting 0.6
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs more explanation because this has a dependency with the service.

@flora-hofmann-frequenz flora-hofmann-frequenz force-pushed the update_api_requirement branch 4 times, most recently from 2d7480f to b154b7b Compare November 27, 2024 10:41
@cwasicki cwasicki changed the title Upgrade to api v0.5.0 Upgrade to reporting API v0.5 Nov 27, 2024
@flora-hofmann-frequenz flora-hofmann-frequenz added this pull request to the merge queue Nov 27, 2024
Merged via the queue into frequenz-floss:v0.x.x with commit a860ac2 Nov 27, 2024
14 checks passed
@flora-hofmann-frequenz flora-hofmann-frequenz deleted the update_api_requirement branch November 27, 2024 11:53
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:tooling Affects the development tooling (CI, deployment, dependency management, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants