Last updated

hideInfoMetadata

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.

hideInfoMetadata: false

To omit the metadata section from the API reference documentation, set the hideInfoMetadata option.

Options

OptionTypeDescription
hideInfoMetadatabooleanOptionally hide the OpenAPI info metadata section of the API reference page. Default value is false.

Examples

The following example hides the metadata content from the API documentation.

redocly.yaml
openapi:
  hideInfoMetadata: true
openapi.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
...

hideInfoMetadata: true

  • openapi - Learn more about using openapi configuration.

Resources

 
Next page