Skip to content

Conversation

@anshchaturvedi
Copy link
Contributor

In wallet-platform-types there are a lot of types (like walletId and coin) which are used in a LOT of files. If you want to add a description to that field then you need to copy-paste the comment for EVERY instance. But, if you try factoring out the fields to a common schema file and then export it where needed, openapi-generator ignores any comments and/or tags that you add to that declaration. We need to add support for this to allow for the refactors.

This PR fixes that and adds a test for it.

Ticket: DX-494

Comment on lines +189 to +192
if (comment !== undefined) {
codecE.right.comment = comment;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This takes inspiration from apiSpec.ts:

if (comment !== undefined) {

@anshchaturvedi anshchaturvedi marked this pull request as ready for review June 19, 2024 19:39
@anshchaturvedi anshchaturvedi requested a review from a team as a code owner June 19, 2024 19:39
@bitgopatmcl bitgopatmcl merged commit a6802a3 into master Jun 20, 2024
@bitgopatmcl bitgopatmcl deleted the DX-494-comments-from-decls branch June 20, 2024 13:13
@github-actions
Copy link

🎉 This PR is included in version @api-ts/openapi-generator@4.15.0 🎉

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

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/express-wrapper@1.0.27 🎉

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

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/superagent-wrapper@1.2.2 🎉

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

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/typed-express-router@1.1.7 🎉

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

Your semantic-release bot 📦🚀

@github-actions
Copy link

github-actions bot commented Aug 5, 2024

🎉 This PR is included in version @api-ts/io-ts-http@3.1.0 🎉

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.

3 participants