x-ignoredHeaderParameters

Usage

Use x-ignoredHeaderParameters to specify header parameter names which should be ignored by Redocly and hidden in the API documentation. Add it to the root OpenAPI object.

Field Name Type Description
x-ignoredHeaderParameters [ string ] List of headers to be ignored and not displayed in the documentation.

Examples

openapi: '3.0'
info:
  ...
tags: [...]
x-ignoredHeaderParameters:
  - Accept
  - User-Agent
  - X-Test-Header