OpenAPITools / OpenAPITools/openapi-generator
[BUG] Need to update typescript-axios to account for type change in 1.2.3
Nobody has claimed this yet.
- 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
Axios recently broke their types by requiring headers in the AxiosRequestConfig type. They "fixed" this in 1.2.3 by creating the RawAxiosRequestConfig type.
openapi-generator version
CLI 2.5.2
Generation Details
Generates requests that match this type signature, and since headers is now required it causes type errors.
async (accessTokenId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs>
The fix is just to change AxiosRequestConfig to RawAxiosRequestConfig
Steps to reproduce
Run generation for typescript-axios.
Related issues/PRs
Suggest a fix
The fix is just to change AxiosRequestConfig to RawAxiosRequestConfig
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 at the typescript-axios generation entry point and search the generator templates for AxiosRequestConfig. Reproduce the issue by generating a typescript-axios client, update the relevant type usage to RawAxiosRequestConfig, and regenerate or run the existing generator checks to confirm the type errors are gone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100