Skip to content
Last updated

x-displayName

Usage

Use x-displayName to add a custom name for a tag. When defined, this custom name is used instead of the default name from the name value in the navigation sidebar and in section headings. Add it to the tag OpenAPI object.

Field NameTypeDescription
x-displayNamestringDefines the text that is used for this tag in the sidebar and in section headings.

Examples

openapi: '3.0'
info: ...
tags:
  - name: sample-123
    description: Example description
    x-displayName: Custom tag name - trait tag

In Reference docs

Tag with a custom name in the navigation sidebar

Related options

Use x-traitTag and x-tagGroups to further customize tags.