Skip to content

Conversation

jpfinne
Copy link
Contributor

@jpfinne jpfinne commented Mar 18, 2025

Fix #20891

Add a new configOption to the spring generator:
useOneOfInterfacesDeduction

When useOneOfInterfaces=true
it allows the generation of an additional annotation on the generated inferface
@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
and the necessary @JsonSubTypes

PR checklist

  • Read the contribution guidelines.
  • [ x] 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 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.
    @cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

Jean-Paul Finne and others added 20 commits December 13, 2023 10:22
# Conflicts:
#	modules/openapi-generator-cli/pom.xml
#	modules/openapi-generator-core/pom.xml
#	modules/openapi-generator-gradle-plugin/pom.xml
#	modules/openapi-generator-maven-plugin/pom.xml
#	modules/openapi-generator-online/pom.xml
#	modules/openapi-generator/pom.xml
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
#	pom.xml
# Conflicts:
#	bin/configs/java-okhttp-user-defined-templates.yaml
#	modules/openapi-generator/src/main/resources/php-flight/register_routes.mustache
#	modules/openapi-generator/src/main/resources/php-flight/register_routes_test.mustache
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
#	modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
#	modules/openapi-generator/src/test/resources/3_0/spring/issue_18340.yaml
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/.github/workflows/maven.yml
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/.openapi-generator/FILES
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradle/wrapper/gradle-wrapper.jar
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradle/wrapper/gradle-wrapper.properties
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradlew
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradlew.bat
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/info.md
#	samples/openapi3/client/petstore/python/tests/test_model.py
#	samples/server/petstore/php-flight/RegisterRoutes.php
#	samples/server/petstore/php-flight/Test/RegisterRoutesTest.php
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java
Copy link
Contributor

@martin-mfg martin-mfg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jpfinne, thanks for the PR! Please merge the 2 fixes I proposed via jpfinne#2. If you want me to explain more in detail which problems are fixed there, let me know. And please solve the merge conflict with master. Then this PR is good to go I think.

jpfinne added 4 commits March 23, 2025 09:51
…into useDeductionForOneOfInterfaces

# Conflicts:
#	modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@jpfinne jpfinne requested a review from martin-mfg March 23, 2025 09:41
Add comment to force rebuild
@jpfinne
Copy link
Contributor Author

jpfinne commented Mar 23, 2025

Hi @jpfinne, thanks for the PR! Please merge the 2 fixes I proposed via jpfinne#2. If you want me to explain more in detail which problems are fixed there, let me know. And please solve the merge conflict with master. Then this PR is good to go I think.

@martin-mfg thanks for the PR.

I've merged your changes and master

When this PR is merged by @wing328 I will implement the samedi Deduction mechanism for java client using Jackson

@rqton
Copy link

rqton commented Jun 11, 2025

Hey there, i was looking for an usage of JsonTypeInfo.Id.DEDUCTION instead of using a discriminator and i landed right here 🚀
Is this feature dead or not ?
Thanks 🙏

@jpfinne
Copy link
Contributor Author

jpfinne commented Jun 12, 2025

Hi @rqton Unfortunately this PR is not merged. Not sure why because it works.
It's discouraging. Maybe you can convince @wing328

In the meantime I use templateDir to override the spring oneof_interface.mustache.
It use the deduction if there is no discriminator.

{{>additionalOneOfTypeAnnotations}}
{{#withXml}}
{{>xmlAnnotation}}
{{/withXml}}
{{#discriminator}}
{{>typeInfoAnnotation}}
{{/discriminator}}{{^discriminator}}
@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
@JsonSubTypes({
    {{#interfaceModels}}
    @JsonSubTypes.Type(value = {{classname}}.class){{^-last}}, {{/-last}}
    {{/interfaceModels}}
})
{{/discriminator}}
{{>generatedAnnotation}}
public {{>sealed}}interface {{classname}}{{#vendorExtensions.x-implements}}{{#-first}} extends {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {{>permits}}{
    {{#discriminator}}
    public {{propertyType}} {{propertyGetter}}();
    {{/discriminator}}
}

@wing328
Copy link
Member

wing328 commented Jul 8, 2025

@jpfinne sorry for late review as there are too many PRs

can you resolve the merge conflicts when you've time?

I'll try to get it merged and included in the upcoming release.

@@ -0,0 +1,12 @@
generatorName: spring
outputDir: samples/openapi3/server/petstore/spring-boot-oneof-interface
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wing328 any chance that this PR get merged?

@jpfinne
Copy link
Contributor Author

jpfinne commented Jul 8, 2025

@jpfinne sorry for late review as there are too many PRs

can you resolve the merge conflicts when you've time?

@wing328 merged

@jpfinne
Copy link
Contributor Author

jpfinne commented Jul 27, 2025

@wing328 is there something missing in this PR?
What can I do to help?

@wing328 wing328 merged commit 7e9b961 into OpenAPITools:master Sep 21, 2025
68 checks passed
@wing328
Copy link
Member

wing328 commented Sep 21, 2025

Just merged. Sorry for the delay

Thanks for the PR as always

@wing328 wing328 added this to the 7.16.0 milestone Sep 28, 2025
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] [JavaSpring] use JsonTypeInfo.Id.DEDUCTION for oneOf interface

4 participants