Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/_data/sidebars/help.yml
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,13 @@ 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
link: /faq/
icon: help-circle
- label: Support and SLA
link: /support-and-sla/
icon: heart-plus
icon: heart-plus
4 changes: 4 additions & 0 deletions src/_help/specification-support/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<head>` 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).
22 changes: 22 additions & 0 deletions src/_help/specification-support/openapi-support/x-display-name.md
Original file line number Diff line number Diff line change
@@ -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)
Binary file added src/images/help/x-displayName.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.