OpenAPITools / OpenAPITools/openapi-generator
[BUG] [typescript] @export is not a valid jsdoc decorator
Open
Beginner friendly
Nobody has claimed this yet.
Issue: Bug
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
in TypeScript, some generated types have the @export decoration - which is not valid per jsdoc.app - the correct form is @exports
openapi-generator version
v7.14.0
OpenAPI declaration file content or url
Generation Details
you need input which is going to trigger the modelOneOf.mustache template
Steps to reproduce
with any such input the incorrect decorator will be generated by the template
Related issues/PRs
Suggest a fix
See #21754
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 modelOneOf.mustache template, which the issue identifies as producing the invalid decorator for TypeScript. Generate a TypeScript client from an input that triggers this template and verify that the output uses @exports rather than @export.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100