Add option to generate a fully `sealed` model in the `JavaSpring` generator #20503

alex-nt · 2025-01-19T08:17:59Z

Add option to generate a fully sealed model in the JavaSpring generator.
Related with #15586

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.
- JDK 17 required to use
- JEP-409
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 Git BASH)
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.
- JavaSpring
  - @cachescrubber
  - @welshm
  - @MelleD
  - @atextor
  - @manedev79
  - @javisst
  - @borsch
  - @banlevente
  - @Zomzog
  - @martin-mfg

martin-mfg

Hi @alex-nt, thanks for the PR!

It generally looks good, but there are some special cases which need to be handled. When using your new feature on the input spec modules/openapi-generator/src/test/resources/3_0/oneOf_array.yaml, this is the generated code:

public sealed interface MyExampleGet200Response permits List&lt;@Valid OneOf1&gt; {

HTML encoding needs to be disabled
generics are not supported in the permits clause, afaik
List shouldn't be in the permits list (same applies to other classes not generated by us)
annotations are not supported in the permits clause, afaik

Could you fix these problems please?

It might also make sense to test with some other "oneOf" files from modules/openapi-generator/src/test/resources/3_0 to find further cases that need special handling.

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

alex-nt · 2025-01-27T08:52:49Z

@martin-mfg Thanks a lot, I'll look into all the oneOf samples, I only tested with the weirdest one and our own file 😅, that was quite naive from me.

…en/languages/SpringCodegen.java Co-authored-by: martin-mfg <[email protected]>

alex-nt · 2025-01-27T15:12:49Z

generics are not supported in the permits clause, afaik

List shouldn't be in the permits list (same applies to other classes not generated by us)

annotations are not supported in the permits clause, afaik

@martin-mfg how should I handle these? Just skip them?

martin-mfg · 2025-01-27T17:12:28Z

flake.lock

Did you intend to include these changes? If yes that's fine. Just want to check, since you didn't include this in your initial PR.

I just ran nix flake update as I wanted to make sure that it has the latest JDK11 build (got burned in the past in a minor jdk11 release). I can revert if that is preferred.

It's fine, leave it as it is. :) No need to revert.

martin-mfg · 2025-01-27T17:13:15Z

how should I handle these? Just skip them?

Yes please. (Unless you have a better idea?)

alex-nt · 2025-01-31T16:36:51Z

@martin-mfg I tested with most of the oneOf samples and it seems ok, I will double check tomorrow with fresh eyes what I did with some test project, hopefully it is ok.

Regarding these 2:

generics are not supported in the permits clause, afaik

Now the collections are skipped, but can there be other generics items there? In the spec it does allow generics (without the parametrized type).

annotations are not supported in the permits clause, afaik

I can't figure out how an annotation would get in there, any test file I should use to test this scenario?

alex-nt · 2025-02-01T07:17:40Z

@martin-mfg so, I think it now works in all scenarios were code generation works for oneOf samples. Unfortunately I found 2 cases where irregardless of the useSealed flag it fails to compile (same thing happens with the latest released version). Seem to be previously existing bugs.

oneOfDiscriminator.yaml

FruitAnyOfDisc.java

@JsonSubTypes.Type(value = AppleAnyOfDisc.class, name = "AppleAnyOfDisc"),
@JsonSubTypes.Type(value = BananaAnyOfDisc.class, name = "BananaAnyOfDisc")

AppleAnyOfDisc and BananaAnyOfDisc are not generated, so it fails to compile.

oneOf_reuseRef.yaml
Banana.java and Apple.java do not implement the method from Fruit.java.

public String getFruitType();

martin-mfg

@alex-nt The new changes mostly look good to me. In addition to the small comments below, there is one more problem: the generated code doesn't compile if the sealed keyword appears anywhere, because the generated pom.xml sets the Java version to 1.8, which is too old for the sealed keyword.

The problems from my earlier comment are all resolved now. 👍 To still answer your questions:

Now the collections are skipped, but can there be other generics items there?

No, I don't think so.

I can't figure out how an annotation would get in there

Since collections are skipped now, annotations should not be a problem anymore.

.../openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java

alex-nt · 2025-02-01T21:24:57Z

@martin-mfg did the cleanup, I hope it is ok (retested with some examples, seems good).

wing328 · 2025-02-09T16:17:34Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java

@@ -59,6 +59,8 @@ public class CodegenModel implements IJsonSchemaValidationProperties {
    public Set<String> oneOf = new TreeSet<>();
    public Set<String> allOf = new TreeSet<>();

+    public List<String> permits = new ArrayList<>();


can you please add a 1-liner explain what permits is?

is that "similar to" children (List<CodegenModel>) ?

Similar but different. children contains the full list of children, even indirect children. permits contains only the direct descendants (first level).

@wing328 do you see this differently? Any suggestion on how I should change it? :D

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

alex-nt added 3 commits January 19, 2025 10:00

Generated sealed interfaces for oneOf

1b7019f

Add generated data

cf33acd

Add also modifier

10fdc9c

alex-nt closed this Jan 19, 2025

Allow sealed for everything

fc96768

alex-nt changed the title ~~Add option to generated sealed interfaces for oneOf in the JavaSpring generator~~ Add option to generated sealed model in the JavaSpring generator Jan 19, 2025

alex-nt changed the title ~~Add option to generated sealed model in the JavaSpring generator~~ Add option to generate a fully sealed model in the JavaSpring generator Jan 19, 2025

Fully seal model

f555437

alex-nt reopened this Jan 19, 2025

martin-mfg suggested changes Jan 27, 2025

View reviewed changes

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java Show resolved Hide resolved

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java Outdated Show resolved Hide resolved

alex-nt and others added 4 commits January 27, 2025 16:44

Merge branch 'master' into feature/java.spring.oneOf.sealed

cbccd95

Disable html escaping

5fca635

Update modules/openapi-generator/src/main/java/org/openapitools/codeg…

31c99b8

…en/languages/SpringCodegen.java Co-authored-by: martin-mfg <[email protected]>

Update docs

9ad36c9

martin-mfg reviewed Jan 27, 2025

View reviewed changes

Check all oneOf scenarios

e0826f6

Fix failed scenario

02b7b74

martin-mfg suggested changes Feb 1, 2025

View reviewed changes

alex-nt added 2 commits February 1, 2025 23:11

Fix comments

1b49d55

Remove unused import

3f407eb

Adapt pom.xml also

1e0a578

martin-mfg approved these changes Feb 2, 2025

View reviewed changes

wing328 reviewed Feb 9, 2025

View reviewed changes

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java Outdated Show resolved Hide resolved

Add comment and remove unused function

0291b11

wing328 merged commit cd7cdb1 into OpenAPITools:master Feb 19, 2025
15 checks passed

wing328 added this to the 7.12.0 milestone Feb 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to generate a fully `sealed` model in the `JavaSpring` generator #20503

Add option to generate a fully `sealed` model in the `JavaSpring` generator #20503

alex-nt commented Jan 19, 2025 •

edited

Loading

martin-mfg left a comment •

edited

Loading

alex-nt commented Jan 27, 2025

alex-nt commented Jan 27, 2025

martin-mfg Jan 27, 2025

alex-nt Jan 27, 2025

martin-mfg Jan 27, 2025

martin-mfg commented Jan 27, 2025

alex-nt commented Jan 31, 2025

alex-nt commented Feb 1, 2025 •

edited

Loading

martin-mfg left a comment

alex-nt commented Feb 1, 2025

wing328 Feb 9, 2025

wing328 Feb 11, 2025

alex-nt Feb 11, 2025 •

edited

Loading

alex-nt Feb 14, 2025

Add option to generate a fully sealed model in the JavaSpring generator #20503

Add option to generate a fully sealed model in the JavaSpring generator #20503

Conversation

alex-nt commented Jan 19, 2025 • edited Loading

PR checklist

martin-mfg left a comment • edited Loading

Choose a reason for hiding this comment

alex-nt commented Jan 27, 2025

alex-nt commented Jan 27, 2025

martin-mfg Jan 27, 2025

Choose a reason for hiding this comment

alex-nt Jan 27, 2025

Choose a reason for hiding this comment

martin-mfg Jan 27, 2025

Choose a reason for hiding this comment

martin-mfg commented Jan 27, 2025

alex-nt commented Jan 31, 2025

alex-nt commented Feb 1, 2025 • edited Loading

martin-mfg left a comment

Choose a reason for hiding this comment

alex-nt commented Feb 1, 2025

wing328 Feb 9, 2025

Choose a reason for hiding this comment

wing328 Feb 11, 2025

Choose a reason for hiding this comment

alex-nt Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

alex-nt Feb 14, 2025

Choose a reason for hiding this comment

Add option to generate a fully `sealed` model in the `JavaSpring` generator #20503

Add option to generate a fully `sealed` model in the `JavaSpring` generator #20503

alex-nt commented Jan 19, 2025 •

edited

Loading

martin-mfg left a comment •

edited

Loading

alex-nt commented Feb 1, 2025 •

edited

Loading

alex-nt Feb 11, 2025 •

edited

Loading