Samples for deduction

Author: jpfinne

bin/configs/spring-boot-oneof-interface.yaml

@@ -0,0 +1,12 @@
+generatorName: spring
+outputDir: samples/openapi3/server/petstore/spring-boot-oneof-interface
+inputSpec: modules/openapi-generator/src/test/resources/3_0/oneof_polymorphism_and_inheritance.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  groupId: org.openapitools.openapi3
+  documentationProvider: springdoc
+  artifactId: springboot-oneof
+  snapshotVersion: "true"
+  hideGenerationTimestamp: "true"
+  useOneOfInterfaces: "true"
+  useDeductionForOneOfInterfaces: "true"

docs/generators/java-camel.md

@@ -72,6 +72,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |licenseName|The name of the license| |Unlicense|
 |licenseUrl|The URL of the license| |http://unlicense.org|
 |modelPackage|package for generated models| |org.openapitools.model|
+|oneOfInterfacesDeduction|whether to use deduction for generated oneOf interfaces| |false|
 |openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|
 |optionalAcceptNullable|Use `ofNullable` instead of just `of` to accept null values when using Optional.| |true|
 |parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|

docs/generators/spring.md

@@ -65,6 +65,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |licenseName|The name of the license| |Unlicense|
 |licenseUrl|The URL of the license| |http://unlicense.org|
 |modelPackage|package for generated models| |org.openapitools.model|
+|oneOfInterfacesDeduction|whether to use deduction for generated oneOf interfaces| |false|
 |openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|
 |optionalAcceptNullable|Use `ofNullable` instead of just `of` to accept null values when using Optional.| |true|
 |parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|

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

@@ -96,7 +96,7 @@ public class SpringCodegen extends AbstractJavaCodegen
     public static final String USE_REQUEST_MAPPING_ON_INTERFACE = "useRequestMappingOnInterface";
     public static final String USE_SEALED = "useSealed";
     public static final String OPTIONAL_ACCEPT_NULLABLE = "optionalAcceptNullable";
-
+    public static final String USE_DEDUCTION_FOR_ONE_OF_INTERFACES = "oneOfInterfacesDeduction";
     @Getter
     public enum RequestMappingMode {
         api_interface("Generate the @RequestMapping annotation on the generated Api Interface."),
@@ -152,6 +152,8 @@ public enum RequestMappingMode {
     protected RequestMappingMode requestMappingMode = RequestMappingMode.controller;
     @Getter @Setter
     protected boolean optionalAcceptNullable = true;
+    @Getter @Setter
+    protected boolean useDeductionForOneOfInterfaces = false;
 
     public SpringCodegen() {
         super();
@@ -260,6 +262,7 @@ public SpringCodegen() {
                 "Use `ofNullable` instead of just `of` to accept null values when using Optional.",
                 optionalAcceptNullable));
 
+        cliOptions.add(CliOption.newBoolean(USE_DEDUCTION_FOR_ONE_OF_INTERFACES, "whether to use deduction for generated oneOf interfaces", useDeductionForOneOfInterfaces));
         supportedLibraries.put(SPRING_BOOT, "Spring-boot Server application.");
         supportedLibraries.put(SPRING_CLOUD_LIBRARY,
                 "Spring-Cloud-Feign client with Spring-Boot auto-configured settings.");

modules/openapi-generator/src/main/resources/JavaSpring/oneof_interface.mustache

@@ -4,6 +4,14 @@
 {{/withXml}}
 {{#discriminator}}
 {{>typeInfoAnnotation}}
+{{/discriminator}}{{^discriminator}}{{#useDeductionForOneOfInterfaces}}
+@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
+@JsonSubTypes({
+    {{#interfaceModels}}
+    @JsonSubTypes.Type(value = {{classname}}.class){{^-last}}, {{/-last}}
+    {{/interfaceModels}}
+})
+{{/useDeductionForOneOfInterfaces}}
 {{/discriminator}}
 {{>generatedAnnotation}}
 public {{>sealed}}interface {{classname}}{{#vendorExtensions.x-implements}}{{#-first}} extends {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {{>permits}}{

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

@@ -1702,10 +1702,12 @@ public void testOneOfAndAllOf() throws IOException {
         generator.setGeneratorPropertyDefault(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "false");
 
         codegen.setUseOneOfInterfaces(true);
+        codegen.setUseDeductionForOneOfInterfaces(true);
         codegen.setLegacyDiscriminatorBehavior(false);
 
         generator.opts(input).generate();
 
+        assertFileContains(Paths.get(outputPath + "/src/main/java/org/openapitools/model/Animal.java"), "@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)", "@JsonSubTypes.Type(value = Dog.class),", "@JsonSubTypes.Type(value = Cat.class)");
         assertFileContains(Paths.get(outputPath + "/src/main/java/org/openapitools/model/Foo.java"), "public class Foo extends Entity implements FooRefOrValue");
         assertFileContains(Paths.get(outputPath + "/src/main/java/org/openapitools/model/FooRef.java"), "public class FooRef extends EntityRef implements FooRefOrValue");
         assertFileContains(Paths.get(outputPath + "/src/main/java/org/openapitools/model/FooRefOrValue.java"), "public interface FooRefOrValue");

modules/openapi-generator/src/test/resources/3_0/oneof_polymorphism_and_inheritance.yaml

@@ -209,6 +209,20 @@ components:
       properties:
         length:
           type: integer
+    Animal:
+      oneOf:
+        - $ref: '#/components/schemas/Dog'
+        - $ref: '#/components/schemas/Cat'
+    Cat:
+      type: object
+      properties:
+        declawed:
+          type: boolean
+    Dog:
+      type: object
+      properties:
+        bark:
+          type: boolean
 
   requestBodies:
     Foo:

samples/client/others/rust/hyper/oneOf/.openapi-generator/FILES

@@ -3,13 +3,16 @@
 Cargo.toml
 README.md
 docs/Addressable.md
+docs/Animal.md
 docs/Apple.md
 docs/Banana.md
 docs/Bar.md
 docs/BarApi.md
 docs/BarCreate.md
 docs/BarRef.md
 docs/BarRefOrValue.md
+docs/Cat.md
+docs/Dog.md
 docs/Entity.md
 docs/EntityRef.md
 docs/Extensible.md
@@ -31,12 +34,15 @@ src/apis/mod.rs
 src/apis/request.rs
 src/lib.rs
 src/models/addressable.rs
+src/models/animal.rs
 src/models/apple.rs
 src/models/banana.rs
 src/models/bar.rs
 src/models/bar_create.rs
 src/models/bar_ref.rs
 src/models/bar_ref_or_value.rs
+src/models/cat.rs
+src/models/dog.rs
 src/models/entity.rs
 src/models/entity_ref.rs
 src/models/extensible.rs

samples/client/others/rust/hyper/oneOf/README.md

@@ -35,12 +35,15 @@ Class | Method | HTTP request | Description
 ## Documentation For Models
 
  - [Addressable](docs/Addressable.md)
+ - [Animal](docs/Animal.md)
  - [Apple](docs/Apple.md)
  - [Banana](docs/Banana.md)
  - [Bar](docs/Bar.md)
  - [BarCreate](docs/BarCreate.md)
  - [BarRef](docs/BarRef.md)
  - [BarRefOrValue](docs/BarRefOrValue.md)
+ - [Cat](docs/Cat.md)
+ - [Dog](docs/Dog.md)
  - [Entity](docs/Entity.md)
  - [EntityRef](docs/EntityRef.md)
  - [Extensible](docs/Extensible.md)

samples/client/others/rust/hyper/oneOf/docs/Animal.md

@@ -0,0 +1,12 @@
+# Animal
+
+## Enum Variants
+
+| Name | Description |
+|---- | -----|
+| Cat |  |
+| Dog |  |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+