Update time filter docs, clarify presence/absence of fields #143
Conversation
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
github-actions
bot
added
the
part:proto
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation for the TimeFilter message in the reporting API, replacing a brief note with comprehensive semantics explaining how the presence or absence of start_time and end_time fields affects stream behavior—including historical data retrieval, real-time streaming, and stream closure.
Key Changes
- Enhanced the message-level documentation with detailed semantics covering all combinations of
start_timeandend_timepresence/absence - Added explicit validation rule that
end_timemust not be in the future - Clarified the behavior differences between historical-only queries (with
end_time) and ongoing real-time streams (withoutend_time)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
stefan-brus-frequenz
force-pushed
the
end_time
branch
from
168f501 to
d7bc941
Compare
stefan-brus-frequenz
force-pushed
the
end_time
branch
from
d7bc941 to
ad64dcb
Compare
Signed-off-by: Stefan Brus <[email protected]>
Signed-off-by: Stefan Brus <[email protected]>
stefan-brus-frequenz
force-pushed
the
end_time
branch
from
ad64dcb to
5477aeb
Compare
github-actions
bot
added
the
part:tooling
stefan-brus-frequenz
force-pushed
the
end_time
branch
4 times, most recently
from
fc2db76 to
6189fcf
Compare
Signed-off-by: Stefan Brus <[email protected]>
stefan-brus-frequenz
force-pushed
the
end_time
branch
from
6189fcf to
6fff88c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.