Improve OpenAPI circular references

[nolannbiron]

Before:

After:

[changeset-bot]

🦋 Changeset detected

Latest commit: 9376c39

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

This PR includes changesets to release 2 packages

Name	Type
@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	URL	Status
Vercel	https://gitbook-v2-jxru825va-gitbook.vercel.app	✅
Cloudflare	https://8d048b94-gitbook-open-v2-preview.gitbook.workers.dev	✅

Test content

Site	2v	2c
GitBook	https://gitbook-v2-jxru825va-gitbook.vercel.app/url/gitbook.com/docs	https://8d048b94-gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs
E2E	https://gitbook-v2-jxru825va-gitbook.vercel.app/url/gitbook.gitbook.io/test-gitbook-open	https://8d048b94-gitbook-open-v2-preview.gitbook.workers.dev/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-v2 (Inspect)	✅ No changes detected	-	Nov 19, 2025, 9:21 PM
v2-cloudflare (Inspect)	👍 Changes approved	6 changed	Nov 19, 2025, 9:25 PM
v2-vercel (Inspect)	👍 Changes approved	8 changed	Nov 19, 2025, 9:24 PM

[Copilot]

Pull Request Overview

This PR improves the handling and visual presentation of circular references in OpenAPI schemas. When a schema references itself, the component now displays a more complete presentation with the circular reference indicator, and ensures proper scroll-to-anchor behavior with updated styling.

• Refactored circular reference handling to render OpenAPISchemaPresentation instead of just OpenAPISchemaCircularRef
• Moved the element ID from OpenAPIDisclosure to its parent wrapper div to enable anchor linking
• Updated circular reference UI with repositioned glyph and improved styling

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
packages/react-openapi/src/OpenAPISchema.tsx	Refactored circular reference rendering to use OpenAPISchemaPresentation with conditional content display; moved ID attribute to wrapper div for proper anchor navigation
packages/gitbook/src/components/DocumentView/OpenAPI/style.css	Added scroll margin for anchor navigation, adjusted circular reference text size and glyph spacing
.changeset/yellow-jobs-nail.md	Added changeset documenting the improvements

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.