The sanitize option enables HTML/Markdown sanitization for the OpenAPI description.
| Option | Type | Description |
|---|---|---|
| sanitize | boolean | Sanitize HTML/Markdown to prevent cross-site scripting (XSS) attacks. Default value is false. |
If set to true, the API description is considered untrusted and all HTML/Markdown is sanitized to prevent XSS.
redocly.yaml
openapi:
sanitize: 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 HTML sanitization practices
- Configuration options - Explore other project configuration options for comprehensive documentation customization