Merge pull request #8600 from swagger-api/fix-lang-in-generation-request

move lang property to GenerationRequest

Author: frantuma

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

@@ -5,6 +5,7 @@
 public class GenerationRequest implements Serializable {
     private static final long serialVersionUID = 1L;
 
+    private String lang;
     private Object spec = null;
     private String specURL = null;
     private Options options = new Options();
@@ -29,6 +30,19 @@ public enum CodegenVersion {
         V2, V3;
     }
 
+    public GenerationRequest lang(String lang) {
+        this.lang = lang;
+        return this;
+    }
+
+    public String getLang() {
+        return lang;
+    }
+    public void setLang(String lang) {
+        this.lang = lang;
+    }
+
+
     public GenerationRequest spec(Object spec) {
         this.spec = spec;
         return this;

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

@@ -32,7 +32,7 @@ public static io.swagger.codegen.ClientOptInput getClientOptInputV2(GenerationRe
             inputSpec = (String)generationRequest.getSpec();
         }
         String inputSpecURL = generationRequest.getSpecURL();
-        String lang = options.getLang();
+        String lang = generationRequest.getLang();
         validateSpec(lang, inputSpec, inputSpecURL);
 
         final List<io.swagger.models.auth.AuthorizationValue> authorizationValues = io.swagger.codegen.auth.AuthParser.parse(generationRequest.getOptions().getAuth());
@@ -177,7 +177,7 @@ public static ClientOptInput getClientOptInput(GenerationRequest generationReque
             inputSpec = (String)generationRequest.getSpec();
         }
         String inputSpecURL = generationRequest.getSpecURL();
-        String lang = options.getLang();
+        String lang = generationRequest.getLang();
         validateSpec(lang, inputSpec, inputSpecURL);
 
         CodegenConfigurator configurator = new CodegenConfigurator();

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

@@ -9,7 +9,6 @@
 
 public class Options {
 
-    private String lang;
     private String auth;
     private AuthorizationValue authorizationValue = null;
     private String apiPackage;
@@ -38,18 +37,6 @@ public class Options {
     private Boolean skipOverride;
     private String outputDir = "";
 
-    public Options lang(String lang) {
-        this.lang = lang;
-        return this;
-    }
-
-    public String getLang() {
-        return lang;
-    }
-    public void setLang(String lang) {
-        this.lang = lang;
-    }
-
     public Options authorizationValue(AuthorizationValue authorizationValue) {
         this.authorizationValue = authorizationValue;
         return this;

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

@@ -23,10 +23,10 @@ public void testGeneratorServiceJava3() {
         request
                 .codegenVersion(GenerationRequest.CodegenVersion.V3)
                 .type(GenerationRequest.Type.SERVER)
+                .lang("jaxrs-jersey")
                 .spec(loadSpecAsNode("3_0_0/petstore.json", false, false))
                 .options(
                         new Options()
-                                .lang("jaxrs-jersey")
                                 .outputDir(getTmpFolder().getAbsolutePath())
                 );
         List<File> files = new GeneratorService().generationRequest(request).generate();
@@ -40,10 +40,10 @@ public void testGeneratorServiceJava2() {
         request
                 .codegenVersion(GenerationRequest.CodegenVersion.V2)
                 .type(GenerationRequest.Type.SERVER)
+                .lang("jaxrs")
                 .spec(loadSpecAsNode("2_0/petstore.json", false, true))
                 .options(
                         new Options()
-                                .lang("jaxrs")
                                 .outputDir(getTmpFolder().getAbsolutePath())
                 );
         List<File> files = new GeneratorService().generationRequest(request).generate();
@@ -57,10 +57,10 @@ public void testGeneratorServiceJava3Spec2() {
         request
                 .codegenVersion(GenerationRequest.CodegenVersion.V3)
                 .type(GenerationRequest.Type.SERVER)
+                .lang("jaxrs-jersey")
                 .spec(loadSpecAsNode("2_0/petstore.json", false, true))
                 .options(
                         new Options()
-                                .lang("jaxrs-jersey")
                                 .outputDir(getTmpFolder().getAbsolutePath())
                 );
         List<File> files = new GeneratorService().generationRequest(request).generate();
@@ -73,10 +73,10 @@ public void testGeneratorServiceJava3RefSpec() {
         request
                 .codegenVersion(GenerationRequest.CodegenVersion.V3)
                 .type(GenerationRequest.Type.SERVER)
+                .lang("jaxrs-jersey")
                 .specURL("3_0_0/petstore.json")
                 .options(
                         new Options()
-                                .lang("jaxrs-jersey")
                                 .outputDir(getTmpFolder().getAbsolutePath())
                 );
         List<File> files = new GeneratorService().generationRequest(request).generate();
@@ -91,10 +91,10 @@ public void testGeneratorServiceJavaClient3() {
         request
                 .codegenVersion(GenerationRequest.CodegenVersion.V3)
                 .type(GenerationRequest.Type.CLIENT)
+                .lang("java")
                 .spec(loadSpecAsNode("3_0_0/petstore.json", false, false))
                 .options(
                         new Options()
-                            .lang("java")
                             .outputDir(getTmpFolder().getAbsolutePath())
                             .artifactId("swagger-petstore-jersey2")
                             .library("jersey2")
@@ -111,10 +111,10 @@ public void testGeneratorServiceJavaClient2() {
         request
                 .codegenVersion(GenerationRequest.CodegenVersion.V2)
                 .type(GenerationRequest.Type.CLIENT)
+                .lang("java")
                 .spec(loadSpecAsNode("2_0/petstore.json", false, true))
                 .options(
                         new Options()
-                                .lang("java")
                                 .outputDir(getTmpFolder().getAbsolutePath())
                                 .artifactId("swagger-petstore-jersey2")
                                 .library("jersey2")

modules/swagger-generator/src/main/java/io/swagger/v3/generator/online/GeneratorController.java

@@ -326,7 +326,7 @@ public ResponseContext generate(RequestContext context, GenerationRequest genera
             outputContentFolder = outputRootFolder;
         }
         generationRequest.getOptions().setOutputDir(outputContentFolder.getAbsolutePath());
-        File outputFile = new File(getTmpFolder(), generationRequest.getOptions().getLang() + "-bundle.zip");
+        File outputFile = new File(getTmpFolder(), generationRequest.getLang() + "-bundle.zip");
 
         LOGGER.info("file zip file: " + outputFile.getAbsolutePath());
 
@@ -364,15 +364,15 @@ private ResponseContext generate(GenerationRequest generationRequest, File outpu
         try {
             files = generatorService.generate();
         } catch (Exception e) {
-            String msg = String.format("Error generating `%s` code : %s", generationRequest.getOptions().getLang(), e.getMessage());
+            String msg = String.format("Error generating `%s` code : %s", generationRequest.getLang(), e.getMessage());
             LOGGER.error(msg, e);
             return new ResponseContext()
                     .status(500)
                     .contentType(MediaType.TEXT_PLAIN)
                     .entity(msg);
         }
         if (files.size() > 0) {
-            return downloadFile(outputRootFolder, outputContentFolder, outputFile, generationRequest.getOptions().getLang(), generationRequest.getType());
+            return downloadFile(outputRootFolder, outputContentFolder, outputFile, generationRequest.getLang(), generationRequest.getType());
         } else {
             return new ResponseContext()
                     .status(500)

modules/swagger-generator/src/main/resources/openapi.yaml

@@ -131,8 +131,13 @@ components:
     GenerationRequest:
       x-swagger-router-model: io.swagger.codegen.v3.service.GenerationRequest
       required:
-      - options
+      - lang
       properties:
+        lang:
+          type: string
+          title: language
+          description: client language to generate (required)
+          example: java
         spec:
           type: object
           description: spec in json format. . Alternative to `specURL`
@@ -170,15 +175,7 @@ components:
           description: Authorization type
     Options:
       x-swagger-router-model: io.swagger.codegen.v3.service.Options
-      required:
-      - lang
       properties:
-        lang:
-          type: string
-          title: language
-          description: client language to generate (maybe class name in classpath,
-            required)
-          example: java
         auth:
           type: string
           title: authorization

modules/swagger-generator/src/test/java/io/swagger/v3/generator/online/GeneratorControllerIT.java

@@ -85,8 +85,8 @@ public void generateJava() throws Exception {
 
         GenerationRequest generationRequest = new GenerationRequest()
                 .spec(spec)
+                .lang("java")
                 .options(new Options()
-                        .lang("java")
                         .addAdditionalProperty("useRuntimeException", true)
                         .addAdditionalProperty("useRxJava", true));
         HttpEntity entity = new StringEntity(Json.pretty(generationRequest), "UTF-8");