Last updated

sanitize

The sanitize option enables HTML/Markdown sanitization for the OpenAPI description.

Options

OptionTypeDescription
sanitizebooleanSanitize HTML/Markdown to prevent cross-site scripting (XSS) attacks. Default value is false.

Examples

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 - Learn more about using openapi configuration.

Resources