OpenAPITools / OpenAPITools/openapi-generator
[BUG][TypeScript] Make ExtendedCodegenOperation and ExtendedCodegenModel public?
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
We have a TypeScript client codegen that inherits from TypeScriptFetchClientCodegen and overrides
the fromModel and fromOperation methods. In previous releases, these methods were inherited directly from DefaultCodegen through TypeScriptFetchClientCodegen. However, version 5.2.1 and above of TypeScriptFetchClientCodegen overrides these methods and returns ExtendedCodegenOperation and ExtendedCodegenModel, which breaks our code generator because the classes ExtendedCodegenOperation and ExtendedCodegenModel have package access. Is there a reason why these classes were given package access? Could they be made public?
openapi-generator version
5.2.1
Suggest a fix
Make the ExtendedCodegenModel and ExtendedCodegenOperation classes public. In fact make all the Extended* classes public.
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 by locating ExtendedCodegenOperation and ExtendedCodegenModel in the Java codegen sources and tracing their use from TypeScriptFetchClientCodegen's fromOperation and fromModel methods. Check whether the affected Extended* classes are intended for external inheritance, then verify that a TypeScript client generator can use the returned types; the issue is resolved when the types are publicly usable without breaking generation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100