Plans:ProScaleEnterprise
The Try it button on a WebSocket channel opens Replay, which connects to the channel's server and sends the channel's messages from your documentation. Use x-hideReplay to hide the Try it button on one channel.
Early access
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.
Use the x-hideReplay extension in a Channel Object.
| Option | Type | Description |
|---|---|---|
| x-hideReplay | boolean | Hides the Try it button on the channel when set to true. Default: false. |
The following example hides the Try it button on the kitchenOrders channel:
channels:
kitchenOrders:
address: /kitchen/orders
x-hideReplay: true
messages:
orderPlaced:
$ref: '#/components/messages/OrderPlaced'
The channel keeps its full documentation, and the other channels keep their Try it button. To hide the button on every channel, use the hideReplay option.
- hideReplay for AsyncAPI - Hide the Try it button on every channel
- Let readers try WebSocket channels - What your description, servers, and project need for the Try it button to connect
- Supported AsyncAPI extensions - All the AsyncAPI extensions Redocly supports