fix(java) #10010 oneOf and readOnly inheritance
TH
8mo ago+314+314+012345678901234567890123456789-4-4-0123456789
The java generator has problems with oneOf wrapper inheritance and inherited readOnly @JsonCreator as you can see in e.g. #10010. An example spec that results in broken generated code is e.g. https://app.swaggerhub.com/apis/cashlink-dev/issuer-api/v2
This PR fixes the issues, so that the java generator will generate compilable code and unit tests.
PR checklist
- Read the contribution guidelines.
- Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
- Run the following to build the project and update samples:
(For Windows users, please run the script in WSL)./mvnw clean package || exit ./bin/generate-samples.sh ./bin/configs/*.yaml || exit ./bin/utils/export_docs_generators.sh || exit
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed. - File the PR against the correct branch:
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks) - If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having
"fixes #123"present in the PR description) - If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)
Summary by cubic
Fixes oneOf wrapper inheritance and inherited readOnly handling in the Java generator so models compile cleanly. Updates the Java native template and regenerates samples. Fixes #10010.
- Bug Fixes
- Detect oneOf wrapper schemas (oneOf + properties/discriminator), inline their properties, and skip them in parent resolution (getParentName/getAllParentsName).
- Mark inherited readOnly vars (x-is-inherited-readonly), add protected setters, and call them from @JsonCreator (supports JsonNullable); use readWriteVars for overridden methods; fix an inverted condition and a type mismatch; add unit tests/specs and update Java native petstore samples.