Fix method naming for openapi normalzier, openapi ignore list option (#…

…18348)

* fix openapi normalizer naming issue in config

* update openapi generator ignore list setting

* update

* fix

* update sample config

* update doc

bin/configs/java-okhttp-gson-swagger1.yaml

@@ -9,4 +9,5 @@ additionalProperties:
   useOneOfDiscriminatorLookup: "true"
   disallowAdditionalPropertiesIfNotPresent: false
   annotationLibrary: "swagger1"
-
+openapiNormalizer:
+  SET_TAGS_FOR_ALL_OPERATIONS: common

bin/configs/kotlin-model-prefix-type-mapping-echo-api.yaml

@@ -12,4 +12,4 @@ additionalProperties:
   enumPropertyNaming: UPPERCASE
   serializationLibrary: gson
 openapiNormalizer:
-  SIMPLIFY_ONEOF_ANYOF=false
+  SIMPLIFY_ONEOF_ANYOF: false

bin/configs/kotlin-model-prefix-type-mapping.yaml

@@ -12,4 +12,4 @@ additionalProperties:
   enumPropertyNaming: UPPERCASE
   serializationLibrary: gson
 openapiNormalizer:
-  SIMPLIFY_ONEOF_ANYOF=false
+  SIMPLIFY_ONEOF_ANYOF: false

docs/customization.md

@@ -304,6 +304,8 @@ You can use also `config.yml` with following equivalent example:
 apiPackage: "petstore"
 ```
 
+Another example of config file can be found in [modules/openapi-generator/src/test/resources/sampleConfig.json](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/sampleConfig.json)
+
 Supported config options can be different per language. Running `config-help -g {lang}` will show available options.
 **These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with `-p {optionName}={optionValue}`**. (If `-p {optionName}` does not work, please open a [ticket](https://github.com/openapitools/openapi-generator/issues/new) and we'll look into it)
 

modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/Generate.java

@@ -515,11 +515,11 @@ public void execute() {
         applyModelNameMappingsKvpList(modelNameMappings, configurator);
         applyEnumNameMappingsKvpList(enumNameMappings, configurator);
         applyOperationIdNameMappingsKvpList(operationIdNameMappings, configurator);
-        applyOpenAPINormalizerKvpList(openapiNormalizer, configurator);
+        applyOpenapiNormalizerKvpList(openapiNormalizer, configurator);
         applyTypeMappingsKvpList(typeMappings, configurator);
         applyAdditionalPropertiesKvpList(additionalProperties, configurator);
         applyLanguageSpecificPrimitivesCsvList(languageSpecificPrimitives, configurator);
-        applyOpenAPIGeneratorIgnoreListCsvList(openapiGeneratorIgnoreList, configurator);
+        applyOpenapiGeneratorIgnoreListCsvList(openapiGeneratorIgnoreList, configurator);
         applyReservedWordsMappingsKvpList(reservedWordsMappings, configurator);
         applyServerVariablesKvpList(serverVariableOverrides, configurator);
 

modules/openapi-generator-core/src/main/java/org/openapitools/codegen/config/GeneratorSettings.java

@@ -321,7 +321,7 @@ public Map<String, String> getOperationIdNameMappings() {
      *
      * @return a map of rules
      */
-    public Map<String, String> getOpenAPINormalizer() {
+    public Map<String, String> getOpenapiNormalizer() {
         return openapiNormalizer;
     }
 
@@ -346,7 +346,7 @@ public Set<String> getLanguageSpecificPrimitives() {
      *
      * @return the openapi generator ignore list
      */
-    public Set<String> getOpenAPIGeneratorIgnoreList() {
+    public Set<String> getOpenapiGeneratorIgnoreList() {
         return openapiGeneratorIgnoreList;
     }
 
@@ -614,14 +614,14 @@ public static Builder newBuilder(GeneratorSettings copy) {
         if (copy.getOperationIdNameMappings() != null) {
             builder.operationIdNameMappings.putAll(copy.getOperationIdNameMappings());
         }
-        if (copy.getOpenAPINormalizer() != null) {
-            builder.openapiNormalizer.putAll(copy.getOpenAPINormalizer());
+        if (copy.getOpenapiNormalizer() != null) {
+            builder.openapiNormalizer.putAll(copy.getOpenapiNormalizer());
         }
         if (copy.getLanguageSpecificPrimitives() != null) {
             builder.languageSpecificPrimitives.addAll(copy.getLanguageSpecificPrimitives());
         }
-        if (copy.getOpenAPIGeneratorIgnoreList() != null) {
-            builder.openapiGeneratorIgnoreList.addAll(copy.getOpenAPIGeneratorIgnoreList());
+        if (copy.getOpenapiGeneratorIgnoreList() != null) {
+            builder.openapiGeneratorIgnoreList.addAll(copy.getOpenapiGeneratorIgnoreList());
         }
         if (copy.getReservedWordsMappings() != null) {
             builder.reservedWordsMappings.putAll(copy.getReservedWordsMappings());
@@ -1152,7 +1152,7 @@ public Builder withOperationIdNameMapping(String key, String value) {
          * @param openapiNormalizer the {@code openapiNormalizer} to set
          * @return a reference to this Builder
          */
-        public Builder withOpenAPINormalizer(Map<String, String> openapiNormalizer) {
+        public Builder withOpenapiNormalizer(Map<String, String> openapiNormalizer) {
             this.openapiNormalizer = openapiNormalizer;
             return this;
         }
@@ -1164,7 +1164,7 @@ public Builder withOpenAPINormalizer(Map<String, String> openapiNormalizer) {
          * @param value The value of the OpenAPI normalizer rule
          * @return a reference to this Builder
          */
-        public Builder withOpenAPINormalizer(String key, String value) {
+        public Builder withOpenapiNormalizer(String key, String value) {
             if (this.openapiNormalizer == null) {
                 this.openapiNormalizer = new HashMap<>();
             }
@@ -1203,7 +1203,7 @@ public Builder withLanguageSpecificPrimitive(String value) {
          * @param openapiGeneratorIgnoreList the {@code openapiGeneratorIgnoreList} to set
          * @return a reference to this Builder
          */
-        public Builder withOpenAPIGeneratorIgnoreList(Set<String> openapiGeneratorIgnoreList) {
+        public Builder withOpenapiGeneratorIgnoreList(Set<String> openapiGeneratorIgnoreList) {
             this.openapiGeneratorIgnoreList = openapiGeneratorIgnoreList;
             return this;
         }
@@ -1214,7 +1214,7 @@ public Builder withOpenAPIGeneratorIgnoreList(Set<String> openapiGeneratorIgnore
          * @param value The value of entry to set
          * @return a reference to this Builder
          */
-        public Builder withOpenAPIGeneratorIgnoreList(String value) {
+        public Builder withOpenapiGeneratorIgnoreList(String value) {
             if (this.openapiGeneratorIgnoreList == null) {
                 this.openapiGeneratorIgnoreList = new HashSet<>();
             }
@@ -1390,9 +1390,9 @@ public boolean equals(Object o) {
                 Objects.equals(getModelNameMappings(), that.getModelNameMappings()) &&
                 Objects.equals(getEnumNameMappings(), that.getEnumNameMappings()) &&
                 Objects.equals(getOperationIdNameMappings(), that.getOperationIdNameMappings()) &&
-                Objects.equals(getOpenAPINormalizer(), that.getOpenAPINormalizer()) &&
+                Objects.equals(getOpenapiNormalizer(), that.getOpenapiNormalizer()) &&
                 Objects.equals(getLanguageSpecificPrimitives(), that.getLanguageSpecificPrimitives()) &&
-                Objects.equals(getOpenAPIGeneratorIgnoreList(), that.getOpenAPIGeneratorIgnoreList()) &&
+                Objects.equals(getOpenapiGeneratorIgnoreList(), that.getOpenapiGeneratorIgnoreList()) &&
                 Objects.equals(getReservedWordsMappings(), that.getReservedWordsMappings()) &&
                 Objects.equals(getGitHost(), that.getGitHost()) &&
                 Objects.equals(getGitUserId(), that.getGitUserId()) &&
@@ -1428,9 +1428,9 @@ public int hashCode() {
                 getModelNameMappings(),
                 getEnumNameMappings(),
                 getOperationIdNameMappings(),
-                getOpenAPINormalizer(),
+                getOpenapiNormalizer(),
                 getLanguageSpecificPrimitives(),
-                getOpenAPIGeneratorIgnoreList(),
+                getOpenapiGeneratorIgnoreList(),
                 getReservedWordsMappings(),
                 getGitHost(),
                 getGitUserId(),

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt

@@ -887,7 +887,7 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
 
             if (openapiNormalizer.isPresent) {
                 openapiNormalizer.get().forEach { entry ->
-                    configurator.addOpenAPINormalizer(entry.key, entry.value)
+                    configurator.addOpenapiNormalizer(entry.key, entry.value)
                 }
             }
 
@@ -917,7 +917,7 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
 
             if (openapiGeneratorIgnoreList.isPresent) {
                 openapiGeneratorIgnoreList.get().forEach {
-                    configurator.addOpenAPIGeneratorIgnoreList(it)
+                    configurator.addOpenapiGeneratorIgnoreList(it)
                 }
             }
 

modules/openapi-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java

@@ -829,7 +829,7 @@ public void execute() throws MojoExecutionException {
 
                 // Retained for backwards-compatibility with configOptions -> openapi-normalizer
                 if (openapiNormalizer == null && configOptions.containsKey("openapi-normalizer")) {
-                    applyOpenAPINormalizerKvp(configOptions.get("openapi-normalizer").toString(),
+                    applyOpenapiNormalizerKvp(configOptions.get("openapi-normalizer").toString(),
                             configurator);
                 }
 
@@ -846,7 +846,7 @@ public void execute() throws MojoExecutionException {
 
                 // Retained for backwards-compatibility with configOptions -> openapi-generator-ignore-list
                 if (openapiGeneratorIgnoreList == null && configOptions.containsKey("openapi-generator-ignore-list")) {
-                    applyOpenAPIGeneratorIgnoreListCsv(configOptions
+                    applyOpenapiGeneratorIgnoreListCsv(configOptions
                             .get("openapi-generator-ignore-list").toString(), configurator);
                 }
 
@@ -919,7 +919,7 @@ public void execute() throws MojoExecutionException {
 
             // Apply OpenAPI normalizer rules
             if (openapiNormalizer != null && (configOptions == null || !configOptions.containsKey("openapi-normalizer"))) {
-                applyOpenAPINormalizerKvpList(openapiNormalizer, configurator);
+                applyOpenapiNormalizerKvpList(openapiNormalizer, configurator);
             }
 
             // Apply Type Mappings
@@ -936,7 +936,7 @@ public void execute() throws MojoExecutionException {
             // Apply Language Specific Primitives
             if (openapiGeneratorIgnoreList != null
                     && (configOptions == null || !configOptions.containsKey("openapi-generator-ignore-list"))) {
-                applyOpenAPIGeneratorIgnoreListCsvList(openapiGeneratorIgnoreList, configurator);
+                applyOpenapiGeneratorIgnoreListCsvList(openapiGeneratorIgnoreList, configurator);
             }
 
             // Apply Additional Properties

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

@@ -358,8 +358,8 @@ public interface CodegenConfig {
 
     boolean getAddSuffixToDuplicateOperationNicknames();
 
-    boolean getUseOpenAPINormalizer();
+    boolean getUseOpenapiNormalizer();
 
-    Set<String> getOpenAPIGeneratorIgnoreList();
+    Set<String> getOpenapiGeneratorIgnoreList();
 
 }

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

@@ -8475,10 +8475,10 @@ public List<VendorExtension> getSupportedVendorExtensions() {
     public boolean getUseInlineModelResolver() { return true; }
 
     @Override
-    public boolean getUseOpenAPINormalizer() { return true; }
+    public boolean getUseOpenapiNormalizer() { return true; }
 
     @Override
-    public Set<String> getOpenAPIGeneratorIgnoreList() {
+    public Set<String> getOpenapiGeneratorIgnoreList() {
         return openapiGeneratorIgnoreList;
     }
 

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

@@ -265,7 +265,7 @@ void configureGeneratorProperties() {
 
         // normalize the spec
         try {
-            if (config.getUseOpenAPINormalizer()) {
+            if (config.getUseOpenapiNormalizer()) {
                 SemVer version = new SemVer(openAPI.getOpenapi());
                 if (version.atLeast("3.1.0")) {
                     config.openapiNormalizer().put("NORMALIZE_31SPEC", "true");
@@ -929,8 +929,8 @@ private boolean apiFilePreCheck(String filename, String generator, String templa
     /*
      * Generate .openapi-generator-ignore if the option openapiGeneratorIgnoreFile is enabled.
      */
-    private void generateOpenAPIGeneratorIgnoreFile() {
-        if (config.getOpenAPIGeneratorIgnoreList() == null || config.getOpenAPIGeneratorIgnoreList().isEmpty()) {
+    private void generateOpenapiGeneratorIgnoreFile() {
+        if (config.getOpenapiGeneratorIgnoreList() == null || config.getOpenapiGeneratorIgnoreList().isEmpty()) {
             return;
         }
 
@@ -982,7 +982,7 @@ private void generateOpenAPIGeneratorIgnoreFile() {
             Writer fileWriter = Files.newBufferedWriter(ignoreFile.toPath(), StandardCharsets.UTF_8);
             fileWriter.write(header);
             // add entries provided by the users
-            for (String entry : config.getOpenAPIGeneratorIgnoreList()) {
+            for (String entry : config.getOpenapiGeneratorIgnoreList()) {
                 fileWriter.write(entry);
                 fileWriter.write("\n");
             }
@@ -1219,7 +1219,7 @@ public List<File> generate() {
         processUserDefinedTemplates();
 
         // generate .openapi-generator-ignore if the option openapiGeneratorIgnoreFile is enabled
-        generateOpenAPIGeneratorIgnoreFile();
+        generateOpenapiGeneratorIgnoreFile();
 
         List<File> files = new ArrayList<>();
         // models

modules/openapi-generator/src/main/java/org/openapitools/codegen/config/CodegenConfigurator.java

@@ -145,14 +145,14 @@ public static CodegenConfigurator fromFile(String configFile, Module... modules)
             if(generatorSettings.getOperationIdNameMappings() != null) {
                 configurator.operationIdNameMappings.putAll(generatorSettings.getOperationIdNameMappings());
             }
-            if(generatorSettings.getOpenAPINormalizer() != null) {
-                configurator.openapiNormalizer.putAll(generatorSettings.getOpenAPINormalizer());
+            if(generatorSettings.getOpenapiNormalizer() != null) {
+                configurator.openapiNormalizer.putAll(generatorSettings.getOpenapiNormalizer());
             }
             if(generatorSettings.getLanguageSpecificPrimitives() != null) {
                 configurator.languageSpecificPrimitives.addAll(generatorSettings.getLanguageSpecificPrimitives());
             }
-            if(generatorSettings.getOpenAPIGeneratorIgnoreList() != null) {
-                configurator.openapiGeneratorIgnoreList.addAll(generatorSettings.getOpenAPIGeneratorIgnoreList());
+            if(generatorSettings.getOpenapiGeneratorIgnoreList() != null) {
+                configurator.openapiGeneratorIgnoreList.addAll(generatorSettings.getOpenapiGeneratorIgnoreList());
             }
             if(generatorSettings.getReservedWordsMappings() != null) {
                 configurator.reservedWordsMappings.putAll(generatorSettings.getReservedWordsMappings());
@@ -268,9 +268,9 @@ public CodegenConfigurator addOperationIdNameMapping(String key, String value) {
         return this;
     }
 
-    public CodegenConfigurator addOpenAPINormalizer(String key, String value) {
+    public CodegenConfigurator addOpenapiNormalizer(String key, String value) {
         this.openapiNormalizer.put(key, value);
-        generatorSettingsBuilder.withOpenAPINormalizer(key, value);
+        generatorSettingsBuilder.withOpenapiNormalizer(key, value);
         return this;
     }
 
@@ -286,9 +286,9 @@ public CodegenConfigurator addLanguageSpecificPrimitive(String value) {
         return this;
     }
 
-    public CodegenConfigurator addOpenAPIGeneratorIgnoreList(String value) {
+    public CodegenConfigurator addOpenapiGeneratorIgnoreList(String value) {
         this.openapiGeneratorIgnoreList.add(value);
-        generatorSettingsBuilder.withOpenAPIGeneratorIgnoreList(value);
+        generatorSettingsBuilder.withOpenapiGeneratorIgnoreList(value);
         return this;
     }
 
@@ -482,9 +482,9 @@ public CodegenConfigurator setOperationIdNameMappings(Map<String, String> operat
         return this;
     }
 
-    public CodegenConfigurator setOpenAPINormalizer(Map<String, String> openapiNormalizer) {
+    public CodegenConfigurator setOpenapiNormalizer(Map<String, String> openapiNormalizer) {
         this.openapiNormalizer = openapiNormalizer;
-        generatorSettingsBuilder.withOpenAPINormalizer(openapiNormalizer);
+        generatorSettingsBuilder.withOpenapiNormalizer(openapiNormalizer);
         return this;
     }
 
@@ -515,10 +515,10 @@ public CodegenConfigurator setLanguageSpecificPrimitives(
         return this;
     }
 
-    public CodegenConfigurator setOpenAPIGeneratorIgnoreList(
+    public CodegenConfigurator setOpenapiGeneratorIgnoreList(
             Set<String> openapiGeneratorIgnoreList) {
         this.openapiGeneratorIgnoreList = openapiGeneratorIgnoreList;
-        generatorSettingsBuilder.withOpenAPIGeneratorIgnoreList(openapiGeneratorIgnoreList);
+        generatorSettingsBuilder.withOpenapiGeneratorIgnoreList(openapiGeneratorIgnoreList);
         return this;
     }
 
@@ -779,9 +779,9 @@ public ClientOptInput toClientOptInput() {
         config.modelNameMapping().putAll(generatorSettings.getModelNameMappings());
         config.enumNameMapping().putAll(generatorSettings.getEnumNameMappings());
         config.operationIdNameMapping().putAll(generatorSettings.getOperationIdNameMappings());
-        config.openapiNormalizer().putAll(generatorSettings.getOpenAPINormalizer());
+        config.openapiNormalizer().putAll(generatorSettings.getOpenapiNormalizer());
         config.languageSpecificPrimitives().addAll(generatorSettings.getLanguageSpecificPrimitives());
-        config.openapiGeneratorIgnoreList().addAll(generatorSettings.getOpenAPIGeneratorIgnoreList());
+        config.openapiGeneratorIgnoreList().addAll(generatorSettings.getOpenapiGeneratorIgnoreList());
         config.reservedWordsMappings().putAll(generatorSettings.getReservedWordsMappings());
         config.additionalProperties().putAll(generatorSettings.getAdditionalProperties());
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/config/CodegenConfiguratorUtils.java

@@ -185,16 +185,16 @@ public static void applyOperationIdNameMappingsKvp(String operationIdNameMapping
         }
     }
 
-    public static void applyOpenAPINormalizerKvpList(List<String> openapiNormalizer, CodegenConfigurator configurator) {
+    public static void applyOpenapiNormalizerKvpList(List<String> openapiNormalizer, CodegenConfigurator configurator) {
         for (String propString : openapiNormalizer) {
-            applyOpenAPINormalizerKvp(propString, configurator);
+            applyOpenapiNormalizerKvp(propString, configurator);
         }
     }
 
-    public static void applyOpenAPINormalizerKvp(String openapiNormalizer, CodegenConfigurator configurator) {
+    public static void applyOpenapiNormalizerKvp(String openapiNormalizer, CodegenConfigurator configurator) {
         final Map<String, String> map = createMapFromKeyValuePairs(openapiNormalizer);
         for (Map.Entry<String, String> entry : map.entrySet()) {
-            configurator.addOpenAPINormalizer(entry.getKey().trim(), entry.getValue().trim());
+            configurator.addOpenapiNormalizer(entry.getKey().trim(), entry.getValue().trim());
         }
     }
 
@@ -250,16 +250,16 @@ public static void applyLanguageSpecificPrimitivesCsv(String languageSpecificPri
         }
     }
 
-    public static void applyOpenAPIGeneratorIgnoreListCsvList(List<String> openapiGeneratorIgnoreList, CodegenConfigurator configurator) {
+    public static void applyOpenapiGeneratorIgnoreListCsvList(List<String> openapiGeneratorIgnoreList, CodegenConfigurator configurator) {
         for (String propString : openapiGeneratorIgnoreList) {
-            applyOpenAPIGeneratorIgnoreListCsv(propString, configurator);
+            applyOpenapiGeneratorIgnoreListCsv(propString, configurator);
         }
     }
 
-    public static void applyOpenAPIGeneratorIgnoreListCsv(String openapiGeneratorIgnoreList, CodegenConfigurator configurator) {
+    public static void applyOpenapiGeneratorIgnoreListCsv(String openapiGeneratorIgnoreList, CodegenConfigurator configurator) {
         final Set<String> set = createSetFromCsvList(openapiGeneratorIgnoreList);
         for (String item : set) {
-            configurator.addOpenAPIGeneratorIgnoreList(item);
+            configurator.addOpenapiGeneratorIgnoreList(item);
         }
     }