OpenAPITools / OpenAPITools/openapi-generator
[BUG] Typescript-axios code generated is not compatiable is erasableSyntaxOnly
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?
- 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
When generating typescript-axios code from openapi, base.ts file contains the following code:
export class BaseAPI {
protected configuration: Configuration | undefined;
constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
if (configuration) {
this.configuration = configuration;
this.basePath = configuration.basePath ?? basePath;
}
}
};
However that code is not compatible with erasableSyntaxOnly because of the scope protected on the constructor parameter.
Looks like the option was introduced here: https://github.com/OpenAPITools/openapi-generator/pull/21040/commits/b0172a5d31208df90aebcdb1142a7e76f39847c8
But that was not implemented for typescript-axios generator
openapi-generator version
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Related issues/PRs
Suggest a fix
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-axios generator and the generated base.ts example described in the issue. Reproduce generation with TypeScript's erasableSyntaxOnly option, then verify that the generated constructor no longer uses the incompatible protected parameter syntax and that the generated code remains valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100