[9.4] [Docs][Dashboards API] Add field descriptions to timeRangeSchema and refreshIntervalSchema (#263281)#263997
Merged
Conversation
…refreshIntervalSchema (elastic#263281) ## Summary Adds API-agnostic field descriptions to two shared schema files used as `$ref` components by the Dashboards API (and other APIs including Maps and ML): - **`kbn-es-query-server` — `timeRangeSchema`**: descriptions for `from`, `to`, and `mode` fields with [date math](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#date-math) links; `title` meta on `absolute`/`relative` variants; object-level `title` and `description`. - **`kbn-data-service-server` — `refreshIntervalSchema`**: fixed inverted `pause` description; improved `value` description; object-level `title` and `description`. All descriptions are API-agnostic and follow the shared schema style rules. ## Test plan - [x] ESLint passes on both files - [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> (cherry picked from commit b066d86)
Merged
2 tasks
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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.
Backport
This will backport the following commits from
mainto9.4:Questions ?
Please refer to the Backport tool documentation