Movatterモバイル変換

[0]ホーム
URL:

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

feat(openapi-typescript): support JSDoc examples from JSON schema examples array#2374

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
cmlee-accelins wants to merge3 commits intoopenapi-ts:main
base:main
Choose a base branch
Loading
fromcmlee-accelins:add-support-for-oas-3.1-examples-in-jsdoc

Conversation

cmlee-accelins
Copy link

@cmlee-accelinscmlee-accelins commentedJul 11, 2025•
edited
Loading

Changes

Implements#2371

Add JSDoc support for the recommendedexamples array on JSON Schema objects. Previously, only examples in the singularexample property were added to the JSDoc, and now all examples in theexamples array are also added as separate examples.

How to Review

The code change was very minor, but since many of the example specs usedexamples already, the snapshots were updated in many places.

Checklist

  • Unit tests updated
  • [n/a]docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

@cmlee-accelinscmlee-accelins requested a review froma team as acode ownerJuly 11, 2025 10:56
@netlifyNetlify
Copy link

netlifybot commentedJul 11, 2025•
edited
Loading

👷 Deploy request foropenapi-ts pending review.

Visit the deploys page to approve it

NameLink
🔨 Latest commit247b337

@changeset-botchangeset-bot
Copy link

changeset-botbot commentedJul 11, 2025•
edited
Loading

🦋 Changeset detected

Latest commit:247b337

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
NameType
openapi-typescriptMinor
swr-openapiMajor

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

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@htunnicliffhtunnicliffAwaiting requested review from htunnicliffhtunnicliff is a code owner automatically assigned from openapi-ts/maintainers

At least 1 approving review is required to merge this pull request.

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

Successfully merging this pull request may close these issues.

1 participant
@cmlee-accelins
[8]ページ先頭
©2009-2025 Movatter.jp