By default, users can see schema field title properties.
The hideSchemaTitles option allows the schema field title to be hidden.
redocly.yaml
schema:
type: 'object'
properties:
name:
title: Title
type: string
description: hooray| Option | Type | Description |
|---|---|---|
| hideSchemaTitles | boolean | Hides the schema title next to the type. Defaults to false. |
The following example hides the schema title properties:
redocly.yaml
openapi:
hideSchemaTitles: true- OpenAPI configuration - Complete guide to OpenAPI configuration options for customizing API reference documentation
- OpenAPI Specification - Official OpenAPI Specification documentation for understanding API description standards
- OpenAPI visual reference - Visual guide to OpenAPI specification structure and schema title customization
- Configuration options - Explore other project configuration options for comprehensive documentation customization