OpenAPI extension: x-metadata
Use x-metadata to add a table of additional data to the top of your API reference documentation. You can add any keys or values that you want users to easily find at the top level of the documentation.
The x-metadata extension is not available in Redoc Community Edition.
The data is formatted as a table and added as part of the description section at the top of the page.
Location
The x-metadata extension can be added to Info Object.
Options
| Option | Type | Description |
|---|---|---|
| x-metadata | Object | Custom metadata in key/value format. |
Examples
x-metadata example
Metadata keys can be any string. The values can be any primitive type, or a list of strings.
The following is an example of an x-metadata section of an OpenAPI description file:
info:
x-metadata:
department: Technical shared services (East)
releaseDate: '12 Mar 2022'
authors:
- Sarah
- Soumya
- SusieThe data is presented as shown in the following screenshot:
x-metadata as filters in classic catalog
The following snippets are examples of x-metadata sections with configured tags you can use to filter APIs in classic catalog.
info:
x-metadata:
tags:
- Booksinfo:
x-metadata:
tags: ["Magazines"]To use tags as filters, the values must be a list.
Resources
- When an API description contains metadata, but you don't want it included in the API reference documentation, use the hideInfoMetadata configuration option to hide it.
- Control which extensions are included in your API reference documentation with the showExtensions configuration setting.
- See all openapi configuration settings.
- See a full list of supported OpenAPI extensions.