schemaDefinitionsTagName
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.
Options
| Option | Type | Description |
|---|---|---|
| schemaDefinitionsTagName | string | Schema definition tag name. |
Examples
The following example sets the schema definition tag name to Schemas.
redocly.yaml
schemaDefinitionsTagName: Schemas
Using the Museum API as an example, all the schemas are shown in the section called "Schemas" at the bottom of the navigation menu:
Related options
- openapi - Learn more about using
openapiconfiguration.
Resources
- Use the
x-tagsspecification extension to select which schemas to display in which sections for more fine-grained control of the output. - OpenAPI Specification