[Dashboards] Improve API documentation for public release#260969

Closed

florent-leborgne wants to merge 46 commits into

mainfrom

worktree-dashboards-api-docs

Commits on Apr 9, 2026

[Dashboards] Improve API documentation for public release

florent-leborgne
and
claude
committed
[Dashboards API] Add route descriptions, 401 responses, and since version

florent-leborgne
and
claude
committed
[Dashboards] Update overlay for upsert semantics from main merge

florent-leborgne
and
claude
committed
[Dashboards] Add sample datasets note and Next steps to overlay

florent-leborgne
and
claude
committed
[Dashboards] Improve Embedding Lens section with sub-headings

florent-leborgne
and
claude
committed
[Dashboards] Remove blank line before info callout in Get started

florent-leborgne
and
claude
committed
[Dashboards] Reframe ES|QL section as positive guidance

florent-leborgne
and
claude
committed
[Dashboards] Add human-readable titles to schema components in overlay

florent-leborgne
and
claude
committed
[Dashboards] Add consistent cURL/Console labels to code samples

florent-leborgne
and
claude
committed
[Dashboards] Add docs link, agent skill, and Agent Builder to info callout

florent-leborgne
and
claude
committed
[Dashboards] Fix overlay schema title targets and add SLO embeddable titles

florent-leborgne
and
claude
committed
[Dashboards] Add post-processing script for schema titles

florent-leborgne
and
claude
committed
[Dashboards] Human-readable schema titles in source code

florent-leborgne
and
claude
committed
[Dashboards] Human-readable schema titles in source code

florent-leborgne
and
claude
committed
[Dashboards] Remove generated OAS output files from tracking

florent-leborgne
and
claude
committed
[Dashboards] Rename by value/by reference → inline/linked

florent-leborgne
and
claude
committed
[Dashboards] Remove remaining by reference mentions

florent-leborgne
and
claude
committed
[Dashboards] Use 'linked from library' for heading and first mention

florent-leborgne
and
claude
committed
[Dashboards] Revert drilldowns registry title transformation

florent-leborgne
and
claude
committed
[Dashboards] Fix overlay POST path + dataset→data_source rename

florent-leborgne
and
claude
committed
[Dashboards] Update panel type lens→vis and de-emphasize Lens term

florent-leborgne
and
claude
committed
[Dashboards] Improve filter schema descriptions with defaults and examples

florent-leborgne
and
claude
committed
[Dashboards] Fix overlay prose and JSON formatting

florent-leborgne
and
claude
committed
[Dashboards] Rework overlay intro: structure, prose, no em dashes

florent-leborgne
and
claude
committed
[Dashboards] Remove premature filters/query/time_range mention from intro

florent-leborgne
and
claude
committed
[Dashboards] Add annotated skeleton to intro showing dashboard structure

florent-leborgne
and
claude
committed
[Dashboards] Replace skeleton code block with structured bullet list

florent-leborgne
and
claude
committed
[Dashboards] Describe dashboard structure as resource, not request body
florent-leborgne
committed
[Dashboards] Add controls to panels structure list and clarify scoping
florent-leborgne
committed
[Dashboards] Restore context-setting intro with Visualizations API disambiguation
florent-leborgne
committed
[Dashboards] Clarify filters/query/time_range description
florent-leborgne
committed
[Dashboards] Rename 'Regular panel' to 'Common panel' in structure list
florent-leborgne
committed
[Dashboards] Reorder sections to match dashboard structure list order
florent-leborgne
committed
[Dashboards] Clarify Visualizations API link: reusable library vs inline
florent-leborgne
committed
[Dashboards] Reduce Visualizations API link repetition in intro
florent-leborgne
committed
[Dashboards] Restructure ES|QL section as bullet list with indented examples
florent-leborgne
committed
[Dashboards] Convert inline/linked and controls placement to bullet lists with indented examples
florent-leborgne
committed
[Dashboards] Add 403, fix categorical bullet, remove Next steps, strip additionalProperties

florent-leborgne
and
claude
committed
[Dashboards] Remove broken overlay remove action (unsupported syntax)
florent-leborgne
committed
[Dashboards] Improve filter condition descriptions to explain operator behavior

florent-leborgne
and
claude
committed
[Dashboards] Add title to groupFilter inner schema
florent-leborgne
committed
[Dashboards] Replace single-panel example with simple and complete examples

florent-leborgne
and
claude
committed
[Dashboards] Simplify Panel_Visualization attributes schema in overlay

florent-leborgne
and
claude
committed
[Dashboards] Clean up schema IDs and add OAS post-processing pipeline

florent-leborgne
and
claude
committed
[Dashboards] Restore description improvements, keep original schema IDs

florent-leborgne
and
claude
committed
[Dashboards] Map vis panel type to 'Visualization' in schema title transform

florent-leborgne
and
claude
committed