Merge pull request #10204 from swagger-api/flattenInlineComposedSchema

Flatten inline composed schema

Author: frantuma

modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/config/CodegenConfigurator.java

@@ -52,6 +52,7 @@ public class CodegenConfigurator implements Serializable {
 
     private String lang;
     private String inputSpec;
+    private boolean flattenInlineSchema;
     private String inputSpecURL;
     private String outputDir;
     private boolean verbose;
@@ -419,15 +420,15 @@ public CodegenConfigurator setIgnoreFileOverride(final String ignoreFileOverride
         this.ignoreFileOverride = ignoreFileOverride;
         return this;
     }
-    
+
     public boolean isResolveFully() {
         return resolveFully;
     }
 
     public CodegenConfigurator setResolveFully(boolean resolveFully) {
         this.resolveFully = resolveFully;
         return this;
-    }    
+    }
 
     public String loadSpecContent(String location, List<AuthorizationValue> auths) throws Exception{
             location = location.replaceAll("\\\\","/");
@@ -474,11 +475,11 @@ public ClientOptInput toClientOptInput() {
             config.setInputSpec(inputSpec);
             ParseOptions options = new ParseOptions();
             options.setResolve(true);
-            options.setFlatten(true);
             options.setResolveFully(resolveFully);
+            options.setFlatten(true);
+            options.setFlattenComposedSchemas(flattenInlineSchema);
             SwaggerParseResult result = new OpenAPIParser().readContents(inputSpec, authorizationValues, options);
             OpenAPI openAPI = result.getOpenAPI();
-
             if (config.needsUnflattenedSpec()) {
                 ParseOptions optionsUnflattened = new ParseOptions();
                 optionsUnflattened.setResolve(true);
@@ -510,8 +511,9 @@ public ClientOptInput toClientOptInput() {
             config.setInputURL(inputSpecURL);
             ParseOptions options = new ParseOptions();
             options.setResolve(true);
-            options.setFlatten(true);
             options.setResolveFully(resolveFully);
+            options.setFlatten(true);
+            options.setFlattenComposedSchemas(flattenInlineSchema);
             SwaggerParseResult result = new OpenAPIParser().readLocation(inputSpecURL, authorizationValues, options);
             OpenAPI openAPI = result.getOpenAPI();
             LOGGER.debug("getClientOptInput - parsed inputSpecURL " + inputSpecURL);
@@ -652,4 +654,10 @@ public static CodegenConfigurator fromFile(String configFile) {
         return null;
     }
 
+    public boolean isFlattenInlineSchem() {
+        return flattenInlineSchema;
+    }
+    public void setFlattenInlineSchema(boolean flattenInlineComposedSchemas) {
+        this.flattenInlineSchema = flattenInlineComposedSchemas;
+    }
 }

modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/service/GeneratorUtil.java

@@ -197,6 +197,8 @@ public static ClientOptInput getClientOptInput(GenerationRequest generationReque
         configurator.setInputSpec(inputSpec);
         configurator.setInputSpecURL(inputSpecURL);
 
+        configurator.setFlattenInlineSchema(generationRequest.getOptions().isFlattenInlineComposedSchemas());
+
         if (isNotEmpty(lang)) {
             configurator.setLang(lang);
             readCodegenArguments(configurator, options);

modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/service/Options.java

@@ -40,6 +40,8 @@ public class Options {
 
     private Map<String, String> codegenArguments = new LinkedHashMap<>();
 
+    private boolean flattenInlineComposedSchemas = false;
+
     public Options authorizationValue(AuthorizationValue authorizationValue) {
         this.authorizationValue = authorizationValue;
         return this;
@@ -429,7 +431,7 @@ public Boolean getSkipOverride() {
     public void setSkipOverride(Boolean skipOverride) {
         this.skipOverride = skipOverride;
     }
-    
+
     public Options resolveFully(Boolean resolveFully) {
         this.resolveFully = resolveFully;
         return this;
@@ -442,4 +444,15 @@ public Boolean getResolveFully() {
     public void setResolveFully(Boolean resolveFully) {
         this.resolveFully = resolveFully;
     }
+
+    public boolean isFlattenInlineComposedSchemas() {
+        return flattenInlineComposedSchemas;
+    }
+    public void setFlattenInlineComposedSchema(boolean flattenInlineComposedSchemas) {
+        this.flattenInlineComposedSchemas = flattenInlineComposedSchemas;
+    }
+    public Options flattenInlineComposedSchema(boolean flattenInlineComposedSchemas) {
+        this.flattenInlineComposedSchemas = flattenInlineComposedSchemas;
+        return this;
+    }
 }

modules/swagger-codegen/src/test/java/io/swagger/codegen/v3/service/GeneratorServiceTest.java

@@ -18,6 +18,37 @@
 
 public class GeneratorServiceTest {
 
+
+    @Test(description = "test generator oneOf ComposedSchema Properties")
+    public void testGenerator_FlattenInlineComposedSchema() throws IOException {
+
+        String path = getTmpFolder().getAbsolutePath();
+        GenerationRequest request = new GenerationRequest();
+        request
+                .codegenVersion(GenerationRequest.CodegenVersion.V3)
+                .type(GenerationRequest.Type.CLIENT)
+                .lang("java")
+                .spec(loadSpecAsNode("3_0_0/FlattenComposedInlineSchema.yaml", true, false))
+                .options(
+                        new Options()
+                                .flattenInlineComposedSchema(true)
+                                .outputDir(path)
+                );
+
+        List<File> files = new GeneratorService().generationRequest(request).generate();
+        Assert.assertFalse(files.isEmpty());
+        for (File f: files) {
+            String relPath = f.getAbsolutePath().substring(path.length());
+            if ("/src/main/java/io/swagger/client/model/ContactbasemodelAllOf1.java".equals(relPath)) {
+                Assert.assertTrue("/src/main/java/io/swagger/client/model/ContactbasemodelAllOf1.java".equals(relPath));
+            }
+            if ("/src/main/java/io/swagger/client/model/TestOneOf2.java".equals(relPath)) {
+                Assert.assertTrue("/src/main/java/io/swagger/client/model/TestOneOf2.java".equals(relPath));
+            }
+        }
+
+    }
+
     @Test(description = "test generator oneOf ComposedSchema Properties")
     public void testGenerator_OneOf_ComposedSchemaProperties() throws IOException {
 

modules/swagger-codegen/src/test/resources/3_0_0/FlattenComposedInlineSchema.yaml

@@ -0,0 +1,73 @@
+openapi: 3.0.2
+info:
+  title: CC-20272 test - OAS3
+  version: 1.0.0
+paths:
+  /something:
+    get:
+      responses:
+        200:
+          description: ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Bar'
+components:
+  schemas:
+    Foo:
+      type: object
+      properties:
+        foo:
+          type: string
+    Bar:
+      type: object
+      properties:
+        foo1:
+          description: An instance of Foo
+          allOf:
+            - $ref: '#/components/schemas/Foo'
+        foo2:
+          $ref: '#/components/schemas/Foo'
+    Test:
+      oneOf:
+        - $ref: "#/components/schemas/Foo"
+        - type: object
+          properties:
+            foo:
+              type: string
+    contact-base-model:
+      allOf:
+        - type: object
+          required:
+            - lastName
+            - email
+          properties:
+            contactId:
+              type: string
+              readOnly: true
+            fullName:
+              type: string
+              readOnly: true
+            firstName:
+              type: string
+            lastName:
+              type: string
+            title:
+              type: string
+            email:
+              type: string
+              format: email
+            passCode:
+              type: string
+              format: password
+            indivId:
+              type: string
+            addresses:
+              type: array
+              items:
+                $ref: '#/components/schemas/Foo'
+            phones:
+              type: array
+              items:
+                $ref: '#/components/schemas/Bar'
+        - $ref: '#/components/schemas/Test'