OpenAPITools / OpenAPITools/openapi-generator

[BUG] [typescript-axios] properly handle type-only imports and avoid duplicate parameters

Open
#12,193 1 comment 0 reactions 0 assignees View on GitHub

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 (example)?
  • 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
  1. Type-only imports are not properly handled in the typescript modules. Imports only used as types should be imported using the "type" keyword.

  2. We have an API parameter called "options" in our API. In the generated api functions, there is also an options arguments appended to every functions to be able to override the Axios instance options. Therefore two

openapi-generator version

5.4.0

Steps to reproduce

Create an OpenApi spec containing a parameter named "options" and try to generate typescript-axios client.

Suggest a fix
  1. Import types properly in the template files.
  2. Rename the Axios related "options" argument in the template files to a more specific name (e.g. axiosOptions).

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.

Research direction

Start with the typescript-axios template files and generate a client from an OpenAPI spec containing a parameter named "options". Inspect the generated imports and API function signatures; done means type-only imports use the type keyword and the generated client has no duplicate options parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.