If a value is set, all of the schemas are rendered with the designated tag name. The schemas then render and display in the sidebar navigation (with that associated tag name). To display only specific schemas, use the x-tags specification extension.
The schemaDefinitionsTagName option is a string that sets the tag name for schema definitions.
| Option | Type | Description |
|---|---|---|
| schemaDefinitionsTagName | string | Schema definition tag name. |
The following example sets the schema definition tag name to Schemas.
redocly.yaml
openapi:
schemaDefinitionsTagName: SchemasUsing the Museum API as an example, all the schemas are shown in the section called "Schemas" at the bottom of the navigation menu:
- OpenAPI configuration - Complete guide to OpenAPI configuration options for customizing API reference documentation
- x-tags specification extension - Use x-tags extension to control which schemas display in specific sections for fine-grained output customization
- OpenAPI Specification - Official OpenAPI Specification documentation for understanding API description standards
- Configuration options - Explore other project configuration options for comprehensive documentation customization