Skip to content

Handle nested deprecated properties in generateSchemaExample #3267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

nolannbiron
Copy link
Member

No description provided.

@nolannbiron nolannbiron requested review from gregberge and Copilot May 26, 2025 17:30
Copy link

linear bot commented May 26, 2025

Copy link

changeset-bot bot commented May 26, 2025

🦋 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

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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', () => {

Copy link

argos-ci bot commented May 26, 2025

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

@nolannbiron nolannbiron merged commit 4c9a9d0 into main May 26, 2025
21 checks passed
@nolannbiron nolannbiron deleted the nolann/rnd-7152-openapi-null-errors-since-latest-release branch May 26, 2025 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants