[9.4] [Docs][Dashboards API] Add field descriptions to asCodeFilterSchema (#263283)#263921
Merged
Merged
Conversation
…lastic#263283) ## Summary Adds missing field descriptions to the `asCodeFilterSchema` in the shared `@kbn/as-code-filters-schema` package. ## What was added - **Condition type schemas** (`is`, `is_one_of`, `range`, `exists`): behavioral descriptions explaining what each condition matches. - **`rangeSchema`**: object-level description; periods on boundary fields; improved `format` description. - **`negatePropertySchema`**, **`disabled`**, **`is_multi_index`**: correct `When \`true\`, …` boolean pattern. - **`controlled_by`**: "Identifier of the panel that manages this filter. When set, the filter is treated as owned by that panel." (per ThomThomson). - **`data_view_id`**: "Identifier of the data view used as context for this filter." (corrected per lukasolson — does not scope the query to a specific index). - **`baseConditionSchema.field`**, **`singleConditionSchema.value`**, **`oneOfConditionSchema.value`**: improved descriptions. - **Group filter** (`operator`, `conditions`, `group` object): new descriptions. - **Top-level filter variants** (`asCodeConditionFilterSchema`, `asCodeGroupFilterSchema`, `asCodeDSLFilterSchema`, `asCodeSpatialFilterSchema`): behavioral object-level descriptions. ## API-agnostic All descriptions are generic — no references to dashboards, Lens, Discover, SLO, or any specific API. ## Test plan - [x] ESLint passes - [x] Descriptions render in combined OAS preview on Bump 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Devon Thomson <devon.thomson@elastic.co> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit dd48b1a)
2 tasks
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
💚 Build Succeeded
Metrics [docs]Async chunks
|
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
3 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.
Backport
This will backport the following commits from
mainto9.4:Questions ?
Please refer to the Backport tool documentation