OpenAPITools / OpenAPITools/openapi-generator
[REQ][typescript-fetch] Add @deprecation tag for deprecated model fields
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
OpenAPI supports deprecated: true definition and typescript supports @deprecated tag from JSDoc to show warnings for using deprecated attributes. But generated clients by typescript-fetch generator do not produce code with @deprecated tag.
Describe the solution you'd like
Similar to https://github.com/OpenAPITools/openapi-generator/pull/19756
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the typescript-fetch generator and compare its generated model output with the approach described in pull request 19756. Verify how OpenAPI deprecated model fields are represented, then ensure generated fields include the TypeScript @deprecated JSDoc tag and confirm the generated output reflects the deprecation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100