{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"openapi","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["openapi"]}]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Customize the behavior and appearance of OpenAPI documentation."," ","Requires an OpenAPI description file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":1},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/code-samples"},"children":["codeSamples"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/code-samples"},"children":["Code Samples object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure the generated code samples in your API documentation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/cors-proxy-url"},"children":["corsProxyUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Overrides the CORS proxy URL used by Replay."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/_api/cors/"]}," (built-in CORS proxy URL)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/download-urls"},"children":["downloadUrls"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/download-urls#api-description-url-object"},"children":["API description URL object"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List the URLs used to download the API description in JSON or YAML format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/events"},"children":["events"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Event hooks to get notified about various user events in API docs"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["excludeFromSearch"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Excludes an OpenAPI description file from search results and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["llms.txt"]}," when set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#exclude-an-api-from-search"},"children":["apply it to a specific files"]},", or to ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#exclude-all-apis-from-search"},"children":["all OpenAPI descriptions"]},"."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["feedback"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/feedback#options"},"children":["Feedback object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hide or customize the type of or text included in the feedback form that displays at the end of each endpoint."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/generated-samples-max-depth"},"children":["generatedSamplesMaxDepth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the number of levels to display in generated payload samples."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/hide-download-buttons"},"children":["hideDownloadButtons"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Toggle the appearance of a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Download OpenAPI description"]}," section."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/hide-info-metadata"},"children":["hideInfoMetadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Toggle the appearance of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OpenAPI info metadata"]}," sections."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/hide-properties-prefix"},"children":["hidePropertiesPrefix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the parent name for nested properties."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/hide-replay"},"children":["hideReplay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the Replay (Try it) functionality."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/hide-schema-titles"},"children":["hideSchemaTitles"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the schema field title next to the type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/json-samples-expand-level"},"children":["jsonSamplesExpandLevel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number | string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the default expand level for JSON payload samples."," ","Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["all"]}," to expand all levels."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/layout"},"children":["layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies layout options for OpenAPI documentation."," ","Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["three-panel"]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stacked"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["three-panel"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/max-displayed-enum-values"},"children":["maxDisplayedEnumValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the number of enum values to display."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/only-required-in-samples"},"children":["onlyRequiredInSamples"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Displays only required fields in request samples."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/sanitize"},"children":["sanitize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sanitize HTML/Markdown to prevent ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://owasp.org/www-community/attacks/xss/"},"children":["cross-site scripting (XSS)"]}," attacks."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/schema-definitions-tag-name"},"children":["schemaDefinitionsTagName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets a schema definitions tag name that is applied to all schemas and displayed in the sidebar navigation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/schemas-expansion-level"},"children":["schemasExpansionLevel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number | string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the default expand level for schemas."," ","Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["all"]}," to expand all levels."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/show-extensions"},"children":["showExtensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string] | boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Displays specification extensions ('x-' fields)."," ","If a list is provided, only those specification extensions are displayed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/show-schema-catalog-links"},"children":["showSchemaCatalogLinks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Displays links to schemas and requests on an OpenAPI page."," ","These links can be used as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$ref"]}," value in other OpenAPI files within the same project."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/sort-required-props-first"},"children":["sortRequiredPropsFirst"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sorts schema properties to display required properties first."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":2},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configure-multiple-apis","__idx":3},"children":["Configure multiple APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In your config file, the openapi options can be defined in the root-level or per-API."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Root-level options apply to all API descriptions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API-level options apply only to individual descriptions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If both are present, then the options are merged, but the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["per-API options take precedence"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows separate configurations for multiple APIs:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"logo: images/awesome-logo.svg\nopenapi:\n  hideReplay: true\napis:\n  museum@default:\n    root: 'openapi/museum.yaml'\n    openapi:\n      downloadUrls:\n        - title: Download OpenApiDescription\n          url: 'https://github.com/Redocly/museum-openapi-example/blob/main/openapi.yaml'\n      hideReplay: false\n      codeSamples:\n        languages:\n          - lang: 'curl'\n            label: 'curl'\n      hideRequestPayloadSample: true\n  museum@test:\n    root: 'openapi/museum-test.yaml'\n    openapi:\n      hideDownloadButtons: true\n      hideReplay: true\n      codeSamples:\n        languages:\n          - lang: 'Node.js'\n          - lang: 'go'\nrules:\n  example-rule-name: error\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"exclude-an-api-from-search","__idx":4},"children":["Exclude an API from search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To exclude a specific API from the search results, locate the API in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," and under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["openapi"]}," key, set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeFromSearch"]}," option to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"apis:\n  museum@default:\n    root: 'openapi/redocly-museum.yaml'\n    openapi:\n      excludeFromSearch: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"exclude-all-apis-from-search","__idx":5},"children":["Exclude all APIs from search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To exclude all APIs from the search results, under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["openapi"]}," key, set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeFromSearch"]}," option to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"openapi:\n  excludeFromSearch: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":6},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://spec.openapis.org/oas/latest.html"},"children":["OpenAPI Specification"]}]}," - Official OpenAPI Specification documentation for understanding API description standards and best practices"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi/config-migration"},"children":["Configuration options changes between reference docs 2.x and newest Redoc configuration"]}]}," - Migrate from reference docs 2.x to the newest Redoc configuration for updated features and functionality"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config"},"children":["Configuration options"]}]}," - Explore other project configuration options for comprehensive documentation and platform customization"]}]}]},"frontmatter":{"products":["Redoc","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"description":"Customize the behavior and appearance of OpenAPI documentation.\nRequires an OpenAPI description file."},"tagList":["configOptionRequirements","table"],"title":"openapi","lastModified":"2026-10-01T23:00:57.000Z"}