Skip to content

Add id and q filter options #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Marenz merged 1 commit into from
Aug 6, 2025
Merged

Add id and q filter options #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

## New Features

- In the `DispatchFilter` message, new fields `dispatch_ids`, and `queries` were added to allow filtering dispatches by ID and a free-text search query across the `id` and `type` fields.

<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes
Expand Down
17 changes: 17 additions & 0 deletions proto/frequenz/api/dispatch/v1/dispatch.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,23 @@ message DispatchFilter {

// Optional filter by update time
frequenz.api.common.v1alpha8.types.Interval update_time_interval = 8;

// Optional filter by dispatch IDs.
// If this field is not set, dispatches with any ID will be included.
// Multiple IDs are combined with an OR relationship.
repeated uint64 dispatch_ids = 9;

// Optional free-text search filter.
//
// This filter is applied to the dispatch `id` and `type` fields.
// The `queries` filter combines multiple queries with an OR relationship.
//
// ID tokens are preceded by a `#` so we can tell if an id is intended or a type.
//
// - input of [`#4`] will match only the record with id of `4`
// - input of [`bar`] will match `bar` and `foobar`
// - input of [`#4`, `#24`, `bar`, `foo`] will match ids of `4` and `24` and types `foo` `bar` `foobar` `foolish bartender`
repeated string queries = 10;
}

// Parameter for controlling which components a dispatch applies to
Expand Down