Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Handle OpenAPI ignored responses #3614

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

Conversation

Copy link
Member

@nolannbiron nolannbiron commented Sep 1, 2025

No description provided.

Copy link

linear bot commented Sep 1, 2025

Copy link

changeset-bot bot commented Sep 1, 2025
edited
Loading

🦋 Changeset detected

Latest commit: ecfe0c1

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

argos-ci bot commented Sep 1, 2025
edited
Loading

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
customers-v2 (Inspect) 👍 Changes approved 2 changed Sep 1, 2025, 12:16 PM
v2-cloudflare (Inspect) 👍 Changes approved 1 changed Sep 1, 2025, 12:20 PM
v2-vercel (Inspect) 👍 Changes approved 2 changed Sep 1, 2025, 12:19 PM

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

This PR adds support for handling OpenAPI responses that should be ignored/hidden from documentation display by filtering out responses with the x-hideSample extension property.

  • Added filtering logic to exclude responses marked with x-hideSample extension
  • Updated the response filtering to check for the custom extension property

Reviewed Changes

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

File Description
packages/react-openapi/src/OpenAPIResponseExample.tsx Added filter condition to exclude responses with x-hideSample extension
.changeset/shaggy-crabs-return.md Added changeset documenting the new feature

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Contributor

@gregberge gregberge left a comment

Choose a reason for hiding this comment

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

Seems good to me, the copilot suggestion is wrong btw.

@nolannbiron nolannbiron merged commit 98e42cf into main Sep 1, 2025
16 checks passed
@nolannbiron nolannbiron deleted the nolann/rnd-7986-code-samples-hidden-with-x-codesamples-but-responses-shows branch September 1, 2025 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@gregberge gregberge gregberge approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /