fix: x-displayName & x-tagGroups cancel eachother out, fix #1719

[hanspagel]

Currently, x-displayName and x-tagGroups don’t play well with each other, see #1719.

This PR fixes it. Instead of overwriting the name, and breaking the logic of what belongs to which tag, we’ll just keep an optional displayTitle which is used to overwrite title (if needed).

Example

openapi: 3.1.0
info:
  title: Tag groups example
x-tagGroups:
  - name: fruits
    tags:
      - fruitPrice
  - name: vegetables
    tags:
      - vegetablePrice
tags:
  - name: fruitPrice
    x-displayName: price
  - name: vegetablePrice
    x-displayName: price
paths:
  '/fruit/price':
    get:
      tags:
        - fruitPrice
      summary: Get fruit price

  '/vegetable/price':
    get:
      tags:
        - vegetablePrice
      summary: Get vegatable price

Result

[changeset-bot]

🦋 Changeset detected

Latest commit: 82bcbb6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages

Name	Type
@scalar/api-reference	Patch
@scalar/api-reference-react	Patch
@scalar/cli	Patch
@scalar/express-api-reference	Patch
@scalar/fastify-api-reference	Patch
@scalar/hono-api-reference	Patch
@scalar/nestjs-api-reference	Patch
@scalar/nextjs-api-reference	Patch
@scalar/nuxt	Patch
@scalar/play-button	Patch
@scalar/docusaurus	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[relativeci]

#1540 Bundle Size — 1.8MiB (~+0.01%).

82bcbb6(current) vs 7dd3231 main#1536(baseline)

Warning

Bundle contains 4 duplicate packages – View duplicate packages

Bundle metrics   2 changes 1 regression

	Current #1540	Baseline #1536
Initial JS	1.8MiB(~+0.01%)	1.8MiB
Initial CSS	0B	0B
Cache Invalidation	100%	0%
Chunks	1	1
Assets	1	1
Modules	1073	1073
Duplicate Modules	0	0
Duplicate Code	0%	0%
Packages	160	160
Duplicate Packages	4	4

Bundle size by type   1 change 1 regression

	Current #1540	Baseline #1536
JS	1.8MiB (~+0.01%)	1.8MiB

---

Bundle analysis report Branch fix/x-display-name-and-x-tag-gro... Project dashboard

[edorgeville]

Didn't expect to wake up to see my issue already fixed, thank you!
I had a look at the changes and tested the preview deployment, everything LGTM :)

[marclave]

✨ nice reporting @edorgeville and awesome fix @hanspagel !

[marclave]

ah! some conflicts @hanspagel then we can get this in ✨

[github-actions]

Preview deployed to https://51022210-ad20-4727-abf2-7165e195f5d1--scalar-deploy-preview.netlify.app