[9.4] [Docs][Dashboards API] Add introduction and get-started overlay (#262396)#262853
Merged
Merged
Conversation
…tic#262396) ## Summary This is the first in a series of focused PRs documenting the Dashboards API for public release. The initial investigation and content drafting was done in elastic#260969 — this series breaks that work into smaller, reviewable chunks. ### This PR (1/4) — Introduction and get-started overlay Adds \`oas_docs/overlays/dashboards.overlays.yaml\`, which sets the tag description for the \`Dashboards\` API group. The overlay covers: - **When to use this API** vs the Visualizations API - **Get started** — auth, CSRF header, and spaces prerequisites, followed by a runnable \`curl\` example (ES|QL line chart using Kibana sample data) - **Dashboard structure** — data model (\`title\`, \`panels\`, \`pinned_panels\`, \`filters\`/\`query\`/\`time_range\`), 48-column grid explanation, and controls placement (sections vs pinned) - **Panel types** — all panel types in a single table (\`vis\`, \`discover_session\`, \`image\`, \`markdown\`, filter controls), observability types (SLO, Synthetics), and a callout for types not yet supported by the REST API (write operations return \`400\`; read operations strip the panel and return a warning) - **Embedding library items** — inline (full config in \`config\`) vs linked-from-library (\`config.ref_id\`) patterns, with working examples and a link to the Visualizations API for the full vis schema - **ES|QL visualizations** — how to use \`data_source.type: "esql"\` with metric and xy chart examples Also wires the overlay into the makefile pipeline. ### Upcoming PRs in this series | PR | Content | |----|---------| | 2/4 | Improved descriptions and titles for all 5 endpoints and their request/response schemas | | 3/4 | Request/response examples for each endpoint | | 4/4 | Bump rendering simplification (strip \`additionalProperties\`, schema ID cleanup, panel type title transforms) | ## Preview https://bump.sh/elastic/hub/elastic-apis/doc/dashboards-api-cleanup-intro-and-get-started/operation/operation-get-dashboards ## Test plan To preview locally: \`\`\`bash make -C oas_docs merge-api-docs-stateful make -C oas_docs api-docs-overlay make -C oas_docs api-docs-preview \`\`\` - [ ] \`make -C oas_docs merge-api-docs-stateful\` generates \`output/kibana.yaml\` with \`/api/dashboards\` endpoints present - [ ] \`make -C oas_docs api-docs-overlay\` applies the dashboards overlay without errors - [ ] \`make -C oas_docs api-docs-preview\` opens a Bump preview showing the Dashboards tag with the full introduction 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit d1ec64f)
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 StepsMetrics [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