docs(api-def): document x-fern-explorer for AsyncAPI channels - #6682
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(api-def): document x-fern-explorer for AsyncAPI channels#6682devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1787159329-asyncapi-explorer-extension.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
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.
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
fern/products/api-def/asyncapi/extensions/explorer.mdx("API Explorer control (AsyncAPI)") — mirrors the shape of its sibling AsyncAPI extension pages: root-levelx-fern-explorer: false, per-channelx-fern-explorer: trueoverride, 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.mdxanddocs/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.2026-08-19.mdx.Checks:
pre-commit run --files <changed>clean (the one Vale error is pre-existing on an untouched line ofapi-explorer.mdx),fern check --warningsreports 0 errors.Link to Devin session: https://app.devin.ai/sessions/9ca03cb676de48119e35825b911bdb84