You can add metadata to an API with the info.x-metadata extension or the metadata configuration option. The API reference displays that metadata by default.
The hideInfoMetadata setting is not available in Redoc Community Edition.
To omit the metadata section, set the hideInfoMetadata option.
| Option | Type | Description |
|---|---|---|
| hideInfoMetadata | boolean | Hide the OpenAPI info metadata section of the API reference page. Default: false. |
The following example hides the metadata content:
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 - All the options you can set under
openapi - OpenAPI Specification - The official standard for API descriptions
- OpenAPI visual reference - A visual map of every part of an OpenAPI description
- Configuration options - All the other options for your project