Introduce API v1alpha11#151
Merged
stefan-brus-frequenz merged 1 commit intoJan 26, 2026
Merged
Conversation
github-actions
Bot
added
part:docs
stefan-brus-frequenz
force-pushed
the
v1alpha11
branch
from
31e2026 to
51251e4
Compare
stefan-brus-frequenz
force-pushed
the
v1alpha11
branch
from
51251e4 to
fb06178
Compare
There was a problem hiding this comment.
Pull request overview
This PR introduces API version v1alpha11 of the Frequenz Reporting Service, focusing on clarifying and improving the documentation of resampling and streaming semantics. The primary goal is to enhance documentation correctness and consistency while introducing some breaking API changes.
Changes:
- Clarified resampling semantics: explicitly defined as time-grid materialization with interval-based timestamps and upsert stream behavior
- Updated
sample_timesemantics to represent origin time when not resampled, interval start when resampled - Changed
TimeFiltermessage to usefrequenz.api.common.v1alpha8.types.Intervalinstead of separatestart_timeandend_timefields - Renamed service from
ReportingtoReportingServiceto align with other Frequenz services - Enhanced documentation with examples showing empty values, interval-based timestamps, and non-append-only behavior
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| proto/frequenz/api/reporting/v1alpha11/reporting.proto | New API version introducing comprehensive documentation updates for resampling and streaming semantics, service renaming, and TimeFilter restructuring |
| RELEASE_NOTES.md | Added release notes documenting the new v1alpha11 API version and its changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
stefan-brus-frequenz
force-pushed
the
v1alpha11
branch
from
fb06178 to
d7d120d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces #146
This PR clarifies resampling and streaming semantics of the Reporting API. The primary focus of this change is documentation correctness and consistency. Some breaking API changes are introduced.
Key improvements:
Resampling is now explicitly defined as time-grid materialization over telemetry data, applied to both historical and real-time streams.
sample_time semantics are clarified:
origin time when not resampled,
interval start when resampled.
Resampled streams are time-keyed upsert streams:
metric values may be unset if no data contributed to an interval,
intervals may be re-emitted with updated values when late telemetry arrives.
Examples and field documentation were updated to reflect:
empty values,
interval-based timestamps,
non-append-only behavior.
Some schema or wire-format changes were made.