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.

Sign up for GitHub

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

Jump to bottom

Option to add JSDoc to generated enums. #2135

Open
1 task done
polaroidkidd opened this issue Feb 3, 2025 · 0 comments
Open
1 task done

Option to add JSDoc to generated enums. #2135

polaroidkidd opened this issue Feb 3, 2025 · 0 comments
Labels
enhancement New feature or request openapi-ts Relevant to the openapi-typescript library

Comments

@polaroidkidd
Copy link

Description

Currently when you generate the types with the below configuration, you'll also generate the accompanying enums. However, when some of the enums are marked as deprecated in the spec, it fails to translate this to the generated enum.

Proposal

The generated enums which are marked as deprecated in the spec are generated with the accompanying JSDoc. This change would be for both the CLI and the Node API and can me an extra option, with the default being true.

Extra
@polaroidkidd polaroidkidd added enhancement New feature or request openapi-ts Relevant to the openapi-typescript library labels Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request openapi-ts Relevant to the openapi-typescript library
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@polaroidkidd