If you include metadata for your APIs, either using the info.x-metadata extension or the metadata configuration option, that information is displayed in the API reference documentation.
The hideInfoMetadata setting is not available in Redoc Community Edition.
To omit the metadata section from the API reference documentation, set the hideInfoMetadata option.
| Option | Type | Description |
|---|---|---|
| hideInfoMetadata | boolean | Optionally hide the OpenAPI info metadata section of the API reference page. Default value is false. |
The following example hides the metadata content from the API documentation.
redocly.yaml
openapi:
hideInfoMetadata: trueopenapi.yaml
openapi: 3.1.0
info:
title: Redocly Museum API
description: Imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.
version: 1.1.0
x-metadata:
createdAt: '2016-11-15T00:53:45.524Z'
domain: fake-museum-example.com
...
- 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 info metadata customization
- Configuration options - Explore other project configuration options for comprehensive documentation customization