[9.4] [Docs][Visualizations API] Add introduction and get-started overlay (#262595)#263007
Merged
Merged
Conversation
…lastic#262595) ## Summary Adds the tag description overlay for the Visualizations API, including an intro, when to use, get started prereqs, a runnable "Try it now" example, a visualization structure overview, and a chart types table. - `oas_docs/overlays/visualizations.overlays.yaml` — new tag description overlay - `oas_docs/makefile` — wires the overlay into the stateful OAS pipeline Mirrors the scope and structure of the Dashboards API PR 1/4 (elastic#262396). No output files committed — the overlay takes effect when the publishing pipeline runs against the full bundle. **Preview:** https://bump.sh/elastic/hub/elastic-apis/doc/visualizations-api-cleanup-intro-get-started/group/endpoint-visualizations ## Part of series - PR 1/4 — intro + get started overlay (this PR) - PR 2/4 — improved endpoint descriptions and response schemas - PR 3/4 — request/response examples per endpoint - PR 4/4 — schema cleanup ## Test plan - [ ] `make api-docs-overlay` exits 0 - [ ] "Try it now" curl runs successfully against a local Kibana with sample logs installed - [ ] Tag description renders correctly in the preview link above --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> (cherry picked from commit 6eacdb4)
3 tasks
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
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