[9.4] [Docs][Dashboards API] Add field descriptions to controls schemas (#263282)#265504
Merged
Merged
Conversation
…astic#263282) ## Summary Adds API documentation descriptions to the shared controls schemas package (`@kbn/controls-schemas`). These schemas are used by both the Dashboards API and Discover — all descriptions are intentionally API-agnostic (they refer to "the control" rather than "the dashboard"). ### Files changed | File | Descriptions added | |---|---| | `control_schema.ts` | 2 (`use_global_filters`, `ignore_validations`) | | `controls_group_schema.ts` | 3 (`width` improved, `grow` added, 4 object-level `description`+`title` fields) | | `options_list_schema.ts` | 20 (all fields in display settings, search technique, sort, selection, DSL control, and ES|QL variable control variants) | | `range_slider_schema.ts` | 2 (`value`/`rangeValueSchema`, `step`) | | `time_slider_schema.ts` | 3 (`start_percentage_of_time_range`, `end_percentage_of_time_range`, `is_anchored`) | **Total: ~30 descriptions added or improved.** ### Style followed - All descriptions end with a period. - Backticks used for field names, literals, and values. - Boolean fields follow the pattern: `When \`true\`, [behaviour]. Defaults to \`X\`.` - Enum/oneOf fields enumerate valid values with explanations and state the default. - Object-level schemas (`discriminatedUnion` variants) received `description` and `title` in their `meta` block. - ES|QL variable controls are consistently referred to as "ES|QL variable controls" to make the connection to the `?variable_name` syntax explicit. ### On `Defaults to X` in description text `defaultValue`, `min`, and `max` in the schema all generate `default`, `minimum`, and `maximum` in the OAS output, which Bump renders automatically. To avoid redundancy: - **Numeric min/max are not repeated** in descriptions — they are already surfaced as OAS constraints. - **`Defaults to X` is kept for boolean and enum fields.** For booleans, the default is important context that is easy to miss in the constraints section; stating it inline with the behaviour description makes the field immediately scannable. For enum fields, the default is kept as part of the sentence that also explains valid values, since splitting them would reduce readability. ### Fields intentionally skipped - `display_settings` (top-level object wrapper) — no description added; the individual child fields (`placeholder`, `hide_*`) are described instead. - `optionsListSelectionSchema` — inline oneOf helper; description added at the `selected_options` array level which is the consumer-visible field. ## Test plan - [ ] Verify no TypeScript errors: `node scripts/type_check --project src/platform/packages/shared/controls/controls-schemas/tsconfig.json` - [ ] Verify no lint errors: `node scripts/eslint src/platform/packages/shared/controls/controls-schemas/src/` - [ ] Confirm OAS output reflects new descriptions by regenerating the OAS bundle --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com> (cherry picked from commit f05e5a9)
3 tasks
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
💚 Build Succeeded
Metrics [docs]
|
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