Add OpenAPI Webhook block

[nolannbiron]

DEMO :

CleanShot.2025-04-15.at.17.17.55.mp4

[linear]

RND-6895 Parser for OpenAPI Webhook block

[changeset-bot]

🦋 Changeset detected

Latest commit: 1e2ef19

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	Minor
gitbook	Minor

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

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

Version 2

Version	URL	Status
Vercel	https://gitbook-v2-dkeu7mm55-gitbook.vercel.app	✅
Cloudflare	https://40d3c0b3-gitbook-open-v2-preview.gitbook.workers.dev	✅

Test content

Site	v1	2v	2c
GitBook	https://b1013cee.gitbook-open.pages.dev/docs.gitbook.com	https://gitbook-v2-dkeu7mm55-gitbook.vercel.app/url/docs.gitbook.com	https://40d3c0b3-gitbook-open-v2-preview.gitbook.workers.dev/url/docs.gitbook.com
E2E	https://b1013cee.gitbook-open.pages.dev/gitbook.gitbook.io/test-gitbook-open	https://gitbook-v2-dkeu7mm55-gitbook.vercel.app/url/gitbook.gitbook.io/test-gitbook-open	https://40d3c0b3-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-v1 (Inspect)	👍 Changes approved	6 changed	Apr 15, 2025, 7:48 PM
customers-v2 (Inspect)	👍 Changes approved	8 changed	Apr 15, 2025, 7:50 PM
default (Inspect)	👍 Changes approved	2 changed	Apr 15, 2025, 7:52 PM
v2-vercel (Inspect)	👍 Changes approved	2 changed	Apr 15, 2025, 7:53 PM

[Copilot]

Pull Request Overview

This PR adds support for an OpenAPI Webhook block to the project by introducing new components, updating types, and integrating the webhook block into the GitBook document view. Key changes include:

• Introducing a new React component (OpenAPIWebhook) and its resolver in both the react-openapi and gitbook packages.
• Updating existing components (e.g., OpenAPISpec, OpenAPIRequestBody, OpenAPIMediaType) to accommodate the new webhook data type.
• Extending type definitions and the fetch/resolve logic and integrating the webhook block into the GitBook UI.

Reviewed Changes

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

Show a summary per file

File	Description
packages/react-openapi/src/OpenAPIWebhook.tsx	New component for displaying the webhook block
packages/react-openapi/src/OpenAPISpec.tsx	Updated to handle OpenAPIWebhookData and conditionally set securities
packages/react-openapi/src/OpenAPIResponseExample.tsx	Refactored to use updated media type content handling
packages/react-openapi/src/OpenAPIRequestBody.tsx	Header now conditionally displays "Payload" for webhook operations
packages/react-openapi/src/OpenAPIOperation.tsx	Simplified operation layout using the new summary component
packages/react-openapi/src/OpenAPIMediaType.tsx	Renamed and refactored media type state and footer components
packages/gitbook/src/lib/openapi/types.ts	Added new type for OpenAPIWebhookBlock
packages/gitbook/src/lib/openapi/resolveOpenAPIWebhookBlock.ts	Added resolver logic for the webhook block
packages/gitbook/src/components/DocumentView/OpenAPI/OpenAPIWebhook.tsx	Integrated new webhook component into the document view
.changeset/light-mirrors-give.md	Documented the addition of the OpenAPI Webhook block

Files not reviewed (3)

• package.json: Language not supported
• packages/cache-tags/package.json: Language not supported
• packages/gitbook/src/components/DocumentView/OpenAPI/style.css: Language not supported

Comments suppressed due to low confidence (1)

packages/react-openapi/src/OpenAPIRequestBody.tsx:21

• Consider using a more explicit type guard or discriminant to determine whether 'data' represents a webhook operation rather than relying on the existence of a 'name' property. This may improve readability and maintainability when differentiating between OpenAPIOperationData and OpenAPIWebhookData.

const header = 'name' in data ? 'Payload' : 'Body';