Skip to content

docs: update description of filter query params in openapi doc#4810

Merged
SuperQ merged 1 commit intoprometheus:mainfrom
waltherlee:update-docs-for-filter-parameters-api-v2
Jan 5, 2026
Merged

docs: update description of filter query params in openapi doc#4810
SuperQ merged 1 commit intoprometheus:mainfrom
waltherlee:update-docs-for-filter-parameters-api-v2

Conversation

@waltherlee
Copy link
Member

@waltherlee waltherlee commented Dec 12, 2025

Re: #2928

Current documentation for filter query params can be read as exclusive instead of inclusive, ie, silenced=true can be understood as excluding non-silenced alerts, when the implementation is actually inclusive and the value means "include silenced alerts as well".

I'm changing the descriptions to mention what results you should expect from the default.

Signed-off-by: Walther Lee <walthere.lee@gmail.com>
@SuperQ SuperQ merged commit b697fae into prometheus:main Jan 5, 2026
7 checks passed
@SoloJacobs SoloJacobs mentioned this pull request Jan 29, 2026
SuperQ added a commit that referenced this pull request Feb 2, 2026
* [ENHANCEMENT] docs(opsgenie): Fix description of `api_url` field. #4908
* [ENHANCEMENT] docs(slack): Document missing app configs. #4871
* [ENHANCEMENT] docs: Fix `max-silence-size-bytes`. #4805
* [ENHANCEMENT] docs: Update expr for `AlertmanagerClusterFailedToSendAlerts` to exclude value 0. #4872
* [ENHANCEMENT] docs: Use matchers for inhibit rules examples. #4131
* [ENHANCEMENT] docs: add notification integrations. #4901
* [ENHANCEMENT] docs: update `slack_config` attachments documentation links. #4802
* [ENHANCEMENT] docs: update description of filter query params in openapi doc. #4810
* [ENHANCEMENT] provider: Reduce lock contention. #4809
* [FEATURE] slack: Add support for top-level text field in slack notification. #4867
* [FEATURE] smtp: Add support for authsecret from file. #3087
* [FEATURE] smtp: Customize the ssl/tls port support (#4757). #4818
* [FEATURE] smtp: Enhance email notifier configuration validation. #4826
* [FEATURE] telegram: Add `chat_id_file` configuration parameter. #4909
* [FEATURE] telegram: Support global bot token. #4823
* [FEATURE] webhook: Support templating in url fields. #4798
* [FEATURE] wechat: Add config directive to pass api secret via file. #4734
* [FEATURE] provider: Implement per alert limits. #4819
* [BUGFIX] Allow empty `group_by` to override parent route. #4825
* [BUGFIX] Set `spellcheck=false` attribute on silence filter input. #4811
* [BUGFIX] jira: Fix for handling api v3 with ADF. #4756
* [BUGFIX] jira: Prevent hostname corruption in cloud api url replacement. #4892
---------

Signed-off-by: Solomon Jacobs <solomonjacobs@protonmail.com>
Signed-off-by: Ben Kochie <superq@gmail.com>
Co-authored-by: Ben Kochie <superq@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants