feat(openapi-typescript): support JSDoc examples from JSON schema examples array #2374
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for openapi-ts ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🦋 Changeset detectedLatest commit: 247b337 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
drwpow
approved these changes
Aug 11, 2025
Contributor
drwpow
left a comment
drwpow
left a comment
There was a problem hiding this comment.
Great addition, and great tests! Thank you! No notes 🙂
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Implements #2371
Add JSDoc support for the recommended
examplesarray on JSON Schema objects. Previously, only examples in the singularexampleproperty were added to the JSDoc, and now all examples in theexamplesarray are also added as separate examples.How to Review
The code change was very minor, but since many of the example specs used
examplesalready, the snapshots were updated in many places.Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)