diff --git a/src/_data/sidebars/help.yml b/src/_data/sidebars/help.yml index 7e2a446b..ddeb5544 100644 --- a/src/_data/sidebars/help.yml +++ b/src/_data/sidebars/help.yml @@ -155,6 +155,8 @@ resources: link: /specification-support/openapi-support/webhooks/ - label: Custom code samples link: /specification-support/doc-code-samples/ + - label: Change tags display name + link: /specification-support/openapi-support/x-display-name/ - label: AsyncAPI support link: /specification-support/asyncapi-support/ - label: FAQ @@ -162,4 +164,4 @@ resources: icon: help-circle - label: Support and SLA link: /support-and-sla/ - icon: heart-plus \ No newline at end of file + icon: heart-plus diff --git a/src/_help/specification-support/extensions.md b/src/_help/specification-support/extensions.md index 1f1878de..b97f1965 100644 --- a/src/_help/specification-support/extensions.md +++ b/src/_help/specification-support/extensions.md @@ -38,3 +38,7 @@ This custom property lets you add links to the navigation bar of your documentat ## Add custom meta tags (`x-metaTags`) This custom property lets you add custom meta tags in the `` tag of your documentation pages. Find out more in our [dedicated section](/help/specification-support/meta-tags). + +## Change tags display name (`x-displayName`) + +This custom property lets you change the display name of your OpenAPI tags. Find out more in our [dedicated section](/help/specification-support/openapi-support/x-display-name). \ No newline at end of file diff --git a/src/_help/specification-support/openapi-support/x-display-name.md b/src/_help/specification-support/openapi-support/x-display-name.md new file mode 100644 index 00000000..1072e799 --- /dev/null +++ b/src/_help/specification-support/openapi-support/x-display-name.md @@ -0,0 +1,22 @@ +--- +title: Change tags display name +--- + +- TOC +{:toc} + +> Supported specification: OpenAPI. +Note that [OpenAPI 3.2](https://spec.openapis.org/oas/v3.2.0.html#fixed-fields-18) now supports `summary` on tags, behaving the same way as `x-displayName`. +{: .info} + +The `x-displayName` property allows for custom tag names. When added, it replaces the default `name` value in the documentation. + +```yaml +tags: + - name: myFirstTag + x-displayName: Branches + - name: mySecondTag + x-displayName: Diffs +``` + +![Screenshot of an example API Documentation on Bump.sh, with x-displayName being used.](/images/help/x-displayName.png) diff --git a/src/images/help/x-displayName.png b/src/images/help/x-displayName.png new file mode 100644 index 00000000..eba1d6db Binary files /dev/null and b/src/images/help/x-displayName.png differ