Add examples rail and restyle API Explorer operation pages - #3973
Open
itsalexcm wants to merge 1 commit into
Open
Add examples rail and restyle API Explorer operation pages#3973itsalexcm wants to merge 1 commit into
itsalexcm wants to merge 1 commit into
Conversation
The examples rail and operation restyle lived on api-docs/improvements, stacked on Nav V2. This branch takes that core and wires it to _ApiPagesNav so the Findability prototype can close. Co-Authored-By: Cursor Grok 4.6 <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
This was referenced Aug 31, 2026
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
1 participant
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.
API Explorer operation pages on
mainnow render an examples rail, breadcrumbs, and HTTP method badges in the current sidebar. Isolatedserveshows the same layout without Nav V2.Affects: API reference, Site UI, Navigation
Why
Operation pages on
mainhave no examples rail and no breadcrumbs. The sidebar also does not paint HTTP method badges, even though the navigation model already carriesIHttpMethodNavigationModel. That page work sat on a Findability-stacked branch that cannot merge tomain.What
Examples rail
Every operation page that has samples or named examples renders
#api-examples-panelbeside the article. Highlighting and copy buttons cover the rail, includingconsoleandcurlblocks. At 1024px and up, the layout becomes a two-column grid driven by CSS:has.Synthetic samples
When an operation has no
x-codeSamples, the generator builds a minimal Console and curl sample from the method, path, required query parameters, required headers, and documentserversURL. Author-provided samples always win.Current sidebar
API pages keep
_ApiPagesNavfrommain._TocTreeNavand_TocTreeNavLegacypaint GET/POST/PUT/DELETE/multi glyphs fromIHttpMethodNavigationModelandIMultiOperationNavigationItem. Nav V2 is not on this branch.Operation page chrome
Breadcrumbs sit above the article. Operation pages restyle request and response cards and keep the property tree. The right rail is examples-only; "On this page" stays hidden.
Out of scope — Nav V2, the Findability hub, and later supplemental catalog work on
main. This PR supersedes #3796.Verify
dotnet test tests/Elastic.ApiExplorer.Tests/ dotnet run --project src/tooling/docs-builder -- serve --port 3000Open
/api/doc/docs-builder-elasticsearch/and an operation page. Confirm the examples rail, breadcrumbs, and method badges.Made with Cursor