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

feat: support private fields in the openapi generator #856

Merged
merged 3 commits into from
Aug 1, 2024
Merged

Conversation

ad-world
Copy link
Contributor

DX-613

This PR enables downstream users of api-ts to mark fields in their codecs with a @private jsdoc tag, which in turn will add the x-internal: true field within the respective schema for that field.

@ad-world ad-world self-assigned this Jul 31, 2024
bitgopatmcl
bitgopatmcl previously approved these changes Aug 1, 2024
'x-unstable'?: boolean;
'x-unknown-tags'?: object;
}>,
expected: any,
Copy link
Contributor

Choose a reason for hiding this comment

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

You can probably do something like OpenAPIV3_1.Document<Record<`x-${string}`, any>> here, but it's a test function so probably not worth the hassle.

@bitgopatmcl bitgopatmcl merged commit 8ccc1a1 into master Aug 1, 2024
6 checks passed
@bitgopatmcl bitgopatmcl deleted the DX-613 branch August 1, 2024 19:18
Copy link

github-actions bot commented Aug 1, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Aug 5, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Aug 5, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Aug 5, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Aug 5, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants