Skip to content
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

fix(openapi-typescript): missing jsdocs comment anyof nested schema #2143

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alewin
Copy link

@alewin alewin commented Feb 6, 2025

Changes

proposal fix for #2142
What does this PR change? Link to any related issue(s).

How to Review

How can a reviewer review your changes? What should be kept in mind for this review?

Checklist

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

Copy link

netlify bot commented Feb 6, 2025

👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit d32ce71

Copy link

changeset-bot bot commented Feb 6, 2025

⚠️ No Changeset found

Latest commit: d32ce71

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

if (anyOfDescriptions.length > 0) {
output.push(`@description ${anyOfDescriptions.join(" | ")}`);
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems like this will still fail for generating jsdoc descriptions for the other compositions allOf and oneOf.

At least in the case of allOf you could re-use this logic and intersect (&) the entries of instead of union-ing (|) them.

Copy link
Author

Choose a reason for hiding this comment

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

yes, makes sense to me. I’ll try to take AllOf and OneOf into account in this PR then

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