Replay lets users make API request from your documentation, to quickly and easily try the experience. Use x-hideReplay to turn off replay for one operation, removing the "Try It" button.
Use the x-hideReplay extension in an Operation declaration.
| Option | Type | Description |
|---|---|---|
| x-hideReplay | boolean | Hides the Replay for the operation on which it was set to true. |
The following example shows how to disable Replay on the ExamplePath operation.
paths:
/example:
get:
summary: Example operation
description: Example description
operationId: examplePath
responses: [...]
parameters: [...]
x-hideReplay: trueThis operation will have complete documentation, but without interactive features.
- Replay API Explorer - Learn about interactive API testing features and how to configure the Try It functionality
- Show extensions configuration - Control which extensions are included in your API reference documentation for optimal presentation
- Mock server configuration - Configure mock server settings used by Replay for API testing and demonstration
- OpenAPI configuration settings - Complete reference for all available OpenAPI configuration options and customization settings
- Supported OpenAPI extensions - Complete list of all OpenAPI extensions supported by Redocly for enhanced API documentation