[Java] [SpringClient] Introduce setting for sealed oneOf interfaces for Spring clients#21586
Merged
wing328 merged 8 commits intoOpenAPITools:masterfrom Jul 28, 2025
Conversation
ae2e74d to
92a1459
Compare
c837b63 to
da84f6b
Compare
Member
|
thanks for the pr let's give it a try |
Goopher
pushed a commit
to Goopher/openapi-generator
that referenced
this pull request
Sep 9, 2025
…or Spring clients (OpenAPITools#21586) * Add setting for generating the oneOf interfaces as sealed interfaces * Generate samples * Add internal java17 additionalProperty setting * Move samples to highlight that they do not use the petstore * Align documentation * Update samples * Align documentation * Update mustache files and samples to change gradle settings to java17
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #15586 by utilizing the functionality from the PR that introduced sealed functionality to the Spring server generation.
Introduces a new setting for the RestClient and WebClient code generator,
useSealedOneOfInterfaces. When set totrueit will create a sealed interface for interfaces that are generated for the settinguseOneOfInterfaces.Due to how these interfaces are generated, I believe a current side effect is that any class implementing an interface will be set to
finalif this new setting is set to true (this stem from the fact that children reuse thevendorExtensions.x-implementsthat is also used when one decorates a class with an interface. This could be solved by introducing an additional vendor extension for oneOf children. But I believe that this is a corner case, and that it is something that can be introduced later if the need is there.I initially considered extending
useOneOfInterfacesfromtrue/falsetotrue/false/sealedor similar, to not increase the amount of configuration settings. But due to how broadly theuseOneOfInterfacesis used and inherited, I decided against it.PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)@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)