Handle nested deprecated properties in generateSchemaExample

[nolannbiron]

No description provided.

[linear]

RND-7152 OpenAPI - NULL errors since latest release

[changeset-bot]

🦋 Changeset detected

Latest commit: 45af44c

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

[Copilot]

Pull Request Overview

Adds support for excluding deprecated properties at both the schema and array-item levels from generated examples.

• Extend deprecation check to array items in generateSchemaExample
• Add tests covering schema-level and nested (array-item) deprecation
• Include a changeset to document the patch

Reviewed Changes

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

File	Description
packages/react-openapi/src/generateSchemaExample.ts	Update deprecation condition to also filter out deprecated items
packages/react-openapi/src/generateSchemaExample.test.ts	Add tests for schema deprecation and nested (array-item) deprecation
.changeset/thick-chefs-repeat.md	Document the patch release in changeset

Comments suppressed due to low confidence (1)

packages/react-openapi/src/generateSchemaExample.test.ts:1030

• [nitpick] The test description should use a consistent verb form (e.g., handles nested deprecated properties) to match the other test and improve naming consistency.

    it('handle nested deprecated properties', () => {

[github-actions]

Summary of the deployments:

Version 1

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

Version 2

Version	URL	Status
Vercel	https://gitbook-v2-98io1dhec-gitbook.vercel.app	✅
Cloudflare	https://5e7388b2-gitbook-open-v2-preview.gitbook.workers.dev	✅

Test content

Site	v1	2v	2c
GitBook	https://cff1e32a.gitbook-open.pages.dev/gitbook.com/docs	https://gitbook-v2-98io1dhec-gitbook.vercel.app/url/gitbook.com/docs	https://5e7388b2-gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs
E2E	https://cff1e32a.gitbook-open.pages.dev/gitbook.gitbook.io/test-gitbook-open	https://gitbook-v2-98io1dhec-gitbook.vercel.app/url/gitbook.gitbook.io/test-gitbook-open	https://5e7388b2-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)	✅ No changes detected	-	May 26, 2025, 5:39 PM
customers-v2 (Inspect)	✅ No changes detected	-	May 26, 2025, 5:40 PM
default (Inspect)	✅ No changes detected	-	May 26, 2025, 5:41 PM
v2-cloudflare (Inspect)	✅ No changes detected	-	May 26, 2025, 5:43 PM
v2-vercel (Inspect)	✅ No changes detected	-	May 26, 2025, 5:44 PM