In complex data structures or object schemas where properties are nested within parent objects the hidePropertiesPrefix option enables the hiding of parent names for nested properties within the documentation.
| Option | Type | Description |
|---|---|---|
| hidePropertiesPrefix | boolean | Shows or hides parent name for the nested properties inside schema. Defaults to false. |
The following example hides the parent object names for nested properties.
redocly.yaml
openapi:
hidePropertiesPrefix: 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 property prefix customization
- Configuration options - Explore other project configuration options for comprehensive documentation customization