openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[Java] [Spring] Use deduction configOptions for oneOfInterfaces

Open jpfinne opened this issue 9 months ago • 3 comments

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

  • [x] 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.
  • [x] 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.
  • [x] 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)

jpfinne avatar Mar 18 '25 09:03 jpfinne

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

jpfinne avatar Mar 23 '25 10:03 jpfinne

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 🙏

rqton avatar Jun 11 '25 09:06 rqton

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}}
}

jpfinne avatar Jun 12 '25 07:06 jpfinne

@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.

wing328 avatar Jul 08 '25 03:07 wing328

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

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

@wing328 merged

jpfinne avatar Jul 08 '25 21:07 jpfinne

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

jpfinne avatar Jul 27 '25 19:07 jpfinne

Just merged. Sorry for the delay

Thanks for the PR as always

wing328 avatar Sep 21 '25 15:09 wing328