Skip to content
Last updated

showSchemaCatalogLinks

Display links with a reference to a specific schema in an OpenAPI file which can be used as $ref value in other OpenAPI files within the same project. These links are always displayed for OpenAPI requests and are shown for schemas when the schemaDefinitionsTagName option is configured.

The showSchemaCatalogLinks setting is not available in Redoc Community Edition.

Options

OptionTypeDescription
showSchemaCatalogLinksbooleanDisplays links to schemas and requests on an OpenAPI page. These links can be used as $ref value in other OpenAPI files within the same project. Default value: false.

Examples

Enable schema catalog links for all APIs in your project.

redocly.yaml
openapi:
  showSchemaCatalogLinks: true

Enable schema catalog links for a single API while keeping them disabled for others.

redocly.yaml
apis:
  main@v1:
    openapi:
      showSchemaCatalogLinks: true

Override global settings to disable schema catalog links for a particular API.

redocly.yaml
openapi:
  showSchemaCatalogLinks: true

apis:
  main@v1:
    openapi:
      showSchemaCatalogLinks: false

Resources

  • OpenAPI configuration - Complete guide to OpenAPI configuration options for customizing API reference documentation
  • Configuration options - Explore other project configuration options for comprehensive documentation customization
  • OpenAPI Specification - Official OpenAPI Specification documentation for understanding API description standards
 
Next page