Support for x-enumDescriptions and x-gitbook-enum

[nolannbiron]

DEMO

CleanShot.2025-03-28.at.21.12.42.mp4

[linear]

RND-6436 Support x-enumDescriptions

[changeset-bot]

🦋 Changeset detected

Latest commit: a7089f9

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

This PR includes changesets to release 3 packages

Name	Type
@gitbook/openapi-parser	Patch
@gitbook/react-openapi	Patch
gitbook	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

[github-actions]

Summary of the deployments:

Version 1 (production)

Version	URL	Status
Latest commit	https://c8b7519b.gitbook-open.pages.dev	✅
PR	https://pr3066.gitbook-open.pages.dev	✅

Version 2 (experimental)

Version	URL	Status
Vercel	https://gitbook-v2-37qljkodc-gitbook.vercel.app	✅
Cloudflare	https://cd682395-gitbook-open-v2-preview.gitbook.workers.dev	✅

Test content

Site	v1	v2
GitBook	https://c8b7519b.gitbook-open.pages.dev/docs.gitbook.com	https://gitbook-v2-37qljkodc-gitbook.vercel.app/url/docs.gitbook.com
E2E	https://c8b7519b.gitbook-open.pages.dev/gitbook.gitbook.io/test-gitbook-open	https://gitbook-v2-37qljkodc-gitbook.vercel.app/url/gitbook.gitbook.io/test-gitbook-open

[argos-ci]

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
customers-v1 (Inspect)	✅ No changes detected	-	Mar 28, 2025, 10:38 PM
customers-v2 (Inspect)	✅ No changes detected	-	Mar 28, 2025, 10:41 PM
default (Inspect)	👍 Changes approved	2 changed	Mar 28, 2025, 10:42 PM
v2-vercel (Inspect)	👍 Changes approved	3 changed	Mar 28, 2025, 10:43 PM

[Copilot]

Pull Request Overview

This PR adds support for x-enumDescriptions and x-gitbook-enum in the OpenAPI components, enhancing the display of enum values with optional descriptive tooltips. Key changes include:

• Implementation of a new OpenAPITooltip component to wrap enum value display.
• Updates to OpenAPISchemaEnum to prioritize x-gitbook-enum and x-enumDescriptions.
• Refactoring of OpenAPICopyButton to utilize the new tooltip component for clipboard actions.

Reviewed Changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/react-openapi/src/OpenAPITooltip.tsx	Introduces a tooltip wrapper component for displaying additional information.
packages/react-openapi/src/OpenAPISchema.tsx	Updates enum rendering to support x-gitbook-enum and x-enumDescriptions, and revises title inference for enums.
packages/react-openapi/src/OpenAPICopyButton.tsx	Refactors copy button to use OpenAPITooltip for improved UX.
packages/openapi-parser/src/types.ts	Adds types for x-enumDescriptions and x-gitbook-enum.
.changeset/tame-colts-know.md	Records version updates and changelog for the new features.

Files not reviewed (1)

• packages/gitbook/src/components/DocumentView/OpenAPI/style.css: Language not supported

Comments suppressed due to low confidence (1)

packages/react-openapi/src/OpenAPISchema.tsx:281

• [nitpick] Consider using a stable unique key (e.g. item.value) instead of the index to improve rendering consistency.

<span key={index} className="openapi-schema-enum-value">