[9.4] [Docs][Visualizations API] Add request and response examples for all 5 endpoints (#262874)#264416
Merged
Merged
Conversation
…5 endpoints (elastic#262874) ## Summary Adds cURL and Console code samples and inlined response examples to all 5 Visualizations API endpoints. ### Code samples (`x-codeSamples`) | Endpoint | Examples | |---|---| | `POST /api/visualizations` | Metric chart (`data_view_spec`); XY line chart; Pie/donut chart; Data table; Metric chart (`data_view_reference`) | | `GET /api/visualizations` | Search visualizations | | `GET /api/visualizations/{id}` | Get a visualization | | `PUT /api/visualizations/{id}` | Update a visualization | | `DELETE /api/visualizations/{id}` | Delete a visualization | Each example has a cURL and Console variant. The `esql` data source is not covered — it is not yet supported by the Visualizations API (returns 400); use the Dashboards API for ES|QL visualizations. ### Response examples | Endpoint | Response code | Named examples | |---|---|---| | `POST /api/visualizations` | 201 | createMetricVisualizationResponse, createXYVisualizationResponse, createPieVisualizationResponse, createDataTableVisualizationResponse, createDataViewReferenceResponse | | `GET /api/visualizations` | 200 | searchVisualizationsResponse (two items: metric + XY) | | `GET /api/visualizations/{id}` | 200 | getVisualizationResponse (metric) | | `PUT /api/visualizations/{id}` | 200 | updateVisualizationResponse (metric) | All payloads tested against a live Kibana 9.4.0 instance using the Kibana sample logs dataset. ## Preview https://bump.sh/elastic/hub/elastic-apis/doc/visualizations-api-cleanup-intro-get-started/group/endpoint-visualizations ## Test plan - [ ] Verify code samples appear in the upper-right dropdown for each endpoint - [ ] Verify response examples appear in the Responses section with correct named tabs - [ ] Confirm all JSON in code samples is fully expanded (no inline objects) 🤖 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 286db8c)
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