Rework OpenAPI Authorizations + scopes

[nolannbiron]

This PR reworks the Authorizations section + introduces a dedicated scopes section

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9ecad33

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[github-actions]

Summary of the deployments:

Version	URL	Status
Vercel	https://gitbook-v2-6ss5mz6o0-gitbook.vercel.app	✅
Cloudflare	https://dc097d77-gitbook-open-v2-preview.gitbook.workers.dev	✅

Test content

Site	2v	2c
GitBook	https://gitbook-v2-6ss5mz6o0-gitbook.vercel.app/url/gitbook.com/docs	https://dc097d77-gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs
E2E	https://gitbook-v2-6ss5mz6o0-gitbook.vercel.app/url/gitbook.gitbook.io/test-gitbook-open	https://dc097d77-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)	⚠️ Changes detected (Review)	5 changed	Nov 6, 2025, 12:09 PM
v2-cloudflare (Inspect)	⚠️ Changes detected (Review)	5 changed	Nov 6, 2025, 12:13 PM
v2-vercel (Inspect)	⚠️ Changes detected (Review)	6 changed	Nov 6, 2025, 12:12 PM

[Copilot]

Pull Request Overview

This PR adds a new "Required Scopes" disclosure section for OpenAPI operations that require authentication scopes. The refactoring extracts scope display logic from the securities section into a dedicated component and introduces state management for disclosure groups using Zustand stores.

• Adds OpenAPIRequiredScopes component to display authentication scopes in a collapsible section
• Implements getOrCreateDisclosureStoreByKey for managing disclosure state across multiple instances
• Refactors OpenAPIDisclosureGroup to support synchronized state management via store keys
• Updates styling to accommodate the new required scopes UI component

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/react-openapi/src/getOrCreateDisclosureStoreByKey.ts	New file implementing Zustand store factory for disclosure group state management
packages/react-openapi/src/context.ts	Adds lock icon to the OpenAPI client context
packages/react-openapi/src/OpenAPISecurities.tsx	Refactors to use new OpenAPIRequiredScopes component and removes inline scope display logic
packages/react-openapi/src/OpenAPIRequiredScopes.tsx	New component for displaying required authentication scopes in a disclosure group
packages/react-openapi/src/OpenAPIDisclosureGroup.tsx	Adds state persistence via Zustand store and support for className prop
packages/react-openapi/src/OpenAPIDisclosure.tsx	Adds defaultExpanded prop and conditional rendering of label and panel
packages/gitbook/src/components/DocumentView/OpenAPI/style.css	Adds styling for required scopes component and refactors nested CSS selectors
packages/gitbook/src/components/DocumentView/OpenAPI/context.tsx	Provides lock icon implementation for GitBook context

---

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