Skip to content

docs(api-def): document x-fern-explorer for AsyncAPI channels - #6682

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787159329-asyncapi-explorer-extension
Open

docs(api-def): document x-fern-explorer for AsyncAPI channels#6682
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787159329-asyncapi-explorer-extension

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

x-fern-explorer — the extension that controls whether the interactive API Explorer is offered for an API — now works in AsyncAPI specs, not just OpenAPI. WebSocket API owners can keep the Playground off for channels where opening a live connection is undesirable, set that default once at the document root, and re-enable it per channel. This mirrors the control they already have over HTTP endpoints, and channels registered before the change keep showing the Playground.

Implements docs for: feat(cli): add x-fern-explorer support for AsyncAPI specs (fern-api/fern#17233) and feat(docs): add includeInApiExplorer for WebSocket channels + honor it in the playground (fern-api/fern-platform#13405).

Pages changed

  • New fern/products/api-def/asyncapi/extensions/explorer.mdx ("API Explorer control (AsyncAPI)") — mirrors the shape of its sibling AsyncAPI extension pages: root-level x-fern-explorer: false, per-channel x-fern-explorer: true override, the resolution rule (channel value, else document value, else enabled), the effect (Playground button hidden for the channel), and that non-boolean values error at import. Tabs cover AsyncAPI 3.0 and 2.x, whose channel objects are spelled differently.
  • asyncapi/extensions/overview.md — new row in the available-extensions table.
  • api-def.yml — registers the page under AsyncAPI > Extensions.
  • openapi/extensions/explorer.mdx and docs/pages/api-references/api-explorer.mdx — one-sentence pointers to the new page, so readers arriving from the OpenAPI extension or the Explorer feature page find the WebSocket behavior.
  • New Docs changelog entry 2026-08-19.mdx.

Checks: pre-commit run --files <changed> clean (the one Vale error is pre-existing on an untouched line of api-explorer.mdx), fern check --warnings reports 0 errors.

Link to Devin session: https://app.devin.ai/sessions/9ca03cb676de48119e35825b911bdb84

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants