By default, the generated request samples include all available fields. The onlyRequiredInSamples option restricts the request samples to include required fields only. Use this option if you have a large number of optional fields that can make request samples difficult to read.
| Option | Type | Description |
|---|---|---|
| onlyRequiredInSamples | boolean | Show only the required fields in request samples. Default value is false. |
The following example produces request samples that show the required properties only:
redocly.yaml
openapi:
onlyRequiredInSamples: true- OpenAPI configuration - Complete guide to OpenAPI configuration options for customizing API reference documentation
- OpenAPI Specification - Official OpenAPI Specification documentation for understanding API description standards
- OpenAPI visual reference - Visual guide to OpenAPI specification structure and sample generation principles
- Configuration options - Explore other project configuration options for comprehensive documentation customization