[BUG] [typescript] @export is not a valid jsdoc decorator

Open Beginner friendly
#21,753 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
tooling

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.

Description

Issue: Bug
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

Dominant language
Java
Stars
26.8k
Forks
7.7k
Avg merge
1d 10h
Merged PRs (30d)
103

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenAPITools/openapi-generator

All issues in OpenAPITools/openapi-generator

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.