The hideReplay option controls whether the Try it button appears on WebSocket channels in AsyncAPI documentation. For example, you can hide the button in your public API docs and keep it visible on your internal site.
This is a feature in early access. It may not be available for your organization yet, and its behavior may change before general availability.
To request access to this feature, contact our Support team.
The hideReplay setting is not available in Redoc Community Edition.
| Option | Type | Description |
|---|---|---|
| hideReplay | boolean | Hide the Try it button that opens Replay on WebSocket channels. Default: false. |
The following example hides the Try it button on every channel of every AsyncAPI description:
asyncapi:
hideReplay: true
The following example hides the button only in the documentation of the events@v1 API:
apis:
events@v1:
root: asyncapi/events.yaml
asyncapi:
hideReplay: true
To hide the button on one channel, use the x-hideReplay extension in the description.
- Let readers try WebSocket channels - What your description, servers, and project need for the Try it button to connect
- x-hideReplay for AsyncAPI - Hide the Try it button on one channel
- AsyncAPI configuration - All the options you can set under
asyncapi - Configuration options - All the other options for your project