OpenAPITools / OpenAPITools/openapi-generator
[BUG][Java][Spring] Generated code fails Error Prone UnnecessaryFinal bug pattern
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 Error Prone is used, its UnncessaryFinal bug pattern fails on the generated HttpInterfacesAbstractConfigurator, because it needlessly marks its sole constructor parameter as final.
openapi-generator version
v7.24.0
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
- in a directory X, create
openapi.yamlandconfig.jsonwith the contents as above - from within X, run
docker run --rm -v .:/local openapitools/openapi-generator-cli:v7.24.0 generate --strict-spec true --input-spec /local/openapi.yaml --generator-name spring --config /local/config.json --output /local/output - open
.\output\src\main\java\org\openapitools\configuration\HttpInterfacesAbstractConfigurator.java
actual: final on the constructor parameter
expected: no final on the constructor parameter
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
Reproduce the issue with the linked openapi.yaml and config.json using the documented Docker command, then inspect the generated HttpInterfacesAbstractConfigurator.java under the Spring output path. Trace that generated constructor back to the Spring generator template and verify that the resulting parameter no longer triggers Error Prone's UnnecessaryFinal pattern.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, spring
- Domain
- backend, tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100