Skip to content
GitLab

[Feature][Java/Spring] Support Discriminator Based OneOf Interface

Merged Administrator requested to merge github/fork/cachescrubber/feature/java_spring_oneof_discriminator_basic into master

Created by: cachescrubber

Support Discriminator Based OneOf Interface

Superseeds

Also Fixes

Brings basic discriminator based OneOf Support to the JavaSpring generator. It generates a marker Interface which the oneOf Models then implement. Technically it requires Jackson based models and is implemented using @JsonTypeInfo and @JsonSubTypes based using a discriminator property.

The relevant Code ist moved to AbstractJavaCodegen and aligned with the other Java based generators in the hierarchy.

The oneOf Support is implemented by utilizing the x-implements vendor extension.

Currently It is enabled in the SpringCodegen only:

useOneOfInterfaces = true;
legacyDiscriminatorBehavior = false;

Synopsis

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "@type", visible = true)
@JsonSubTypes({
  @JsonSubTypes.Type(value = Foo.class, name = "Foo"),
  @JsonSubTypes.Type(value = FooRef.class, name = "FooRef")
})

@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
public interface FooRefOrValue {
    public String getAtType();
}

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 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.