OpenAPITools / OpenAPITools/openapi-generator
[REQ] [JAVA] Generation should exit with error when an unsupported serialization library is chosen
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
Related to #18829 – although it is documented in the library option, it would be much more helpful to users if it would fail hard.
Describe the solution you'd like
Ideally, the generator would know about this and exit with a helpful message. Less ideal, it would just throw an exception (might lead to more bug reports than it saves).
Approach
Generally, the current codebase lacks the ability to programmatically query this kind of information from one place. I've started to develop a structured enum that may could be used for this task and also simplify the existing assignment of serializationLibrary in processOpts():
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 serialization-library cases and test setup in JavaClientCodegenTest.java, then trace how processOpts() assigns serializationLibrary. Define what happens for an unsupported choice and verify that generation exits with a helpful error message, adding coverage in the referenced test area.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100