Skip to content

[Java] [SpringClient] Introduce setting for sealed oneOf interfaces for Spring clients #21586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

Mattias-Sehlstedt
Copy link
Contributor

@Mattias-Sehlstedt Mattias-Sehlstedt commented Jul 18, 2025

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 to true it will create a sealed interface for interfaces that are generated for the setting useOneOfInterfaces.

Due to how these interfaces are generated, I believe a current side effect is that any class implementing an interface will be set to final if this new setting is set to true (this stem from the fact that children reuse the vendorExtensions.x-implements that 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 useOneOfInterfaces from true/false to true/false/sealed or similar, to not increase the amount of configuration settings. But due to how broadly the useOneOfInterfaces is used and inherited, I decided against it.

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:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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 (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • 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)

@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the spring-client-sealed-interface-2 branch 2 times, most recently from ae2e74d to 92a1459 Compare July 18, 2025 12:30
@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the spring-client-sealed-interface-2 branch from c837b63 to da84f6b Compare July 18, 2025 13:13
@Mattias-Sehlstedt Mattias-Sehlstedt marked this pull request as ready for review July 18, 2025 17:02
@Mattias-Sehlstedt Mattias-Sehlstedt changed the title Introduce setting for sealed oneOf interfaces for Spring clients [Java] [SpringClient] Introduce setting for sealed oneOf interfaces for Spring clients Jul 19, 2025
@wing328
Copy link
Member

wing328 commented Jul 28, 2025

thanks for the pr

let's give it a try

@wing328 wing328 merged commit 7c4ada3 into OpenAPITools:master Jul 28, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] Java: generate sealed interfaces for oneOf
2 participants