Assembler: generate API Explorer pages behind staging flag - #3819
Open
reakaleek wants to merge 7 commits into
Open
Assembler: generate API Explorer pages behind staging flag#3819reakaleek wants to merge 7 commits into
reakaleek wants to merge 7 commits into
Conversation
Wire OpenApiGenerator into assembler builds only when assembler-api-explorer is enabled (staging), and add a gated synthetics journey that exercises /docs/api and the version switcher. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Move API Explorer generation off the docs-builder docset: discover api: blocks from any assembled set, aggregate one catalog, and validate duplicate keys. Split OpenApiGenerator into product and catalog steps. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
reakaleek
marked this pull request as ready for review
August 11, 2026 08:35
reakaleek
added a commit
to elastic/docs-content
that referenced
this pull request
Aug 11, 2026
## Why Assembler API Explorer generation now discovers `api:` blocks from assembled docsets instead of docs-builder. The narrative docset must own the site-wide API declarations so staging builds can render `/docs/api/` after the docs-builder change lands. ## What Adds the six remote `api:` keys to `docset.yml` and moves the Kibana spaces child page to `api/kibana/kibana-api-overview.md`. Explicit `repository:` values are kept so specs resolve from their owner repos even though the declaring checkout is docs-content. ## Notes Land this PR before or together with [elastic/docs-builder#3819](elastic/docs-builder#3819). Made with [Cursor](https://cursor.com) --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Select only visible operation links so collapsed navigation entries do not cause the journey to time out. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Mpdreamz
approved these changes
Aug 11, 2026
The API Explorer synthetic looked for an operation link on a product landing page, but every sidebar group renders collapsed there: the subtree is hidden until its checkbox is checked, and the client script only expands ancestors of the current page. The step now opens the first collapsed branch until an operation link is clickable. Assembler OpenAPI tests also created scratch directories in the repository root and never removed them. They now use a disposable temporary directory under the gitignored .artifacts folder, which stays inside the working directory root that ScopedFileSystem requires. Co-authored-by: Cursor <cursoragent@cursor.com>
The final step waited for #elastic-docs-v3, the content wrapper of the markdown layout. Operation pages render #elastic-api-v3 instead, so the assertion could never pass. Checking for a wrapper also proved nothing about the page, so the step now asserts the HTTP method and route that the operation renders under "Paths". Co-authored-by: Cursor <cursoragent@cursor.com>
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
2 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.
Why
What
assembler-api-explorerfeature flag, enabled only for the staging assembler environment.OpenApiGeneratorinto the assembler build when the flag is on, fetching multi-version specs from the version index./docs/apithat uses the API version switcher, gated onFEATURE_ASSEMBLER_API_EXPLORER.Notes
/docs/api/until the bump.sh proxy cutover (elastic/docs-eng-team#725).FEATURE_ASSEMBLER_API_EXPLORER=trueso local synthetics can exercise generated API pages.Made with Cursor