Update description for filter param in OpenAPI#4775
Merged
SuperQ merged 1 commit intoprometheus:mainfrom Dec 5, 2025
Merged
Conversation
Signed-off-by: Walther Lee <walthere.lee@gmail.com>
waltherlee
force-pushed
the
update-api-v2-doc-for-alert-filters
branch
from
9ff3635 to
1d1b808
Compare
Merged
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
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.
Re: #2812
filteris an array, but multiple items have to be added by repeating the param. This can be confusing since "a list of matchers" could be understood as a list separated by comma in a single value, or a group of matchers in promql format.I'm changing the description to explicitly say that the value has to be a single matcher expression, but multiple values can be applied by repeating the param. Also fixed a typo in alert groups that said "alerts" instead of "alert groups".
The main change is in
api/v2/openapi.yaml. All the others were autogenerated withmake apiv2