Fix gauge chart API example units and note API versioning - #7593
Open
florent-leborgne wants to merge 1 commit into
Open
Fix gauge chart API example units and note API versioning#7593florent-leborgne wants to merge 1 commit into
florent-leborgne wants to merge 1 commit into
Conversation
- gauge-charts.md: use the current duration format unit codes (us/ms) so the example validates against the GA Visualizations API schema. - Add a shared note before every API payload example pointing readers to the Kibana and Serverless breaking changes release notes. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
28 tasks
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.
Summary
Follow-up to the Dashboards and Visualizations API GA work (#7057).
gauge-charts.md: the duration format units in the API example used the old preview codes (microseconds/asMilliseconds). Updated to the GA schema unit codes (us/ms) so the request validates._snippets/api-payload-version-note.md) before every API payload example, pointing readers to the Kibana and Elastic Cloud Serverless breaking changes release notes so they can track field changes across versions.The area chart example keeps its inline
data_view_specfor the query annotation. On 9.5 that currently returns a 500 (elastic/kibana#280977), but this is likely a bug that will be resolved, so the example reflects the intended behavior.