docs(openapi): give alert pipeline examples a real if shape - #308
Merged
Conversation
The three alert-pipeline examples all used `"if": null` or an empty `rules` array, so nothing in them exercised the filter field. Generated clients validate their model layer by decoding these canonical examples, and a null decodes into any shape — which is why the `if` field could carry the wrong type without any example failing. Give the examples the shapes the endpoints actually return: - `pipeline/info` and `pipeline/upsert`: a `title_reset` rule with an `if` condition and a `[TPL]` title template, alongside the existing unconditional `severity_reset`. - `pipeline/list`: an `alert_inhibit` rule, so `settings.source_filters` is covered too. Both fields now decode from a real payload rather than from `null`.
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
1 participant
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.
The three alert-pipeline examples all used
"if": nullor an emptyrulesarray, so nothing in them exercised the filter field. Generated clients validate their model layer by decoding these canonical examples, andnulldecodes into any shape — which is whyifcould carry the wrong type without any example failing.Examples now carry the shapes the endpoints actually return:
pipeline/info+pipeline/upsert— atitle_resetrule with anifcondition and a[TPL]title template, alongside the existing unconditionalseverity_reset.pipeline/list— analert_inhibitrule, sosettings.source_filtersis covered too.Follow-up to #307, which corrected the schema for those two fields.