add enum name mapping to java generators

OpenAPITools · Nov 9, 2023 · 8e5ac16 · 8e5ac16
1 parent f35b132
commit 8e5ac16
Show file tree

Hide file tree

Showing 16 changed files with 156 additions and 1 deletion.
diff --git a/bin/configs/java-okhttp-gson.yaml b/bin/configs/java-okhttp-gson.yaml
@@ -14,3 +14,6 @@ additionalProperties:
   hideGenerationTimestamp: "true"
   useOneOfDiscriminatorLookup: "true"
   disallowAdditionalPropertiesIfNotPresent: false
+enumNameMappings:
+  s: LOWER_CASE_S
+  S: UPPER_CASE_S
diff --git a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java
@@ -89,6 +89,9 @@ public class ConfigHelp extends OpenApiGeneratorCommand {
     @Option(name = {"--model-name-mappings"}, title = "model name mappings", description = "displays the model name mappings (none)")
     private Boolean modelNameMappings;
 
+    @Option(name = {"--enum-name-mappings"}, title = "enum name mappings", description = "displays the enum name mappings (none)")
+    private Boolean enumNameMappings;
+
     @Option(name = {"--openapi-normalizer"}, title = "openapi normalizer rules", description = "displays the OpenAPI normalizer rules (none)")
     private Boolean openapiNormalizer;
 
@@ -542,6 +545,18 @@ private void generatePlainTextHelp(StringBuilder sb, CodegenConfig config) {
             sb.append(newline);
         }
 
+        if (Boolean.TRUE.equals(enumNameMappings)) {
+            sb.append(newline).append("ENUM NAME MAPPING").append(newline).append(newline);
+            Map<String, String> map = config.enumNameMapping()
+                    .entrySet()
+                    .stream()
+                    .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a, b) -> {
+                        throw new IllegalStateException(String.format(Locale.ROOT, "Duplicated options! %s and %s", a, b));
+                    }, TreeMap::new));
+            writePlainTextFromMap(sb, map, optIndent, optNestedIndent, "enum name", "Mapped to");
+            sb.append(newline);
+        }
+
         if (Boolean.TRUE.equals(openapiNormalizer)) {
             sb.append(newline).append("OPENAPI NORMALIZER RULES").append(newline).append(newline);
             Map<String, String> map = config.openapiNormalizer()

diff --git a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/Generate.java b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/Generate.java
@@ -209,6 +209,13 @@ public class Generate extends OpenApiGeneratorCommand {
                     + " You can also have multiple occurrences of this option.")
     private List<String> modelNameMappings = new ArrayList<>();
 
+    @Option(
+            name = {"--enum-name-mappings"},
+            title = "enum name mappings",
+            description = "specifies mappings between the enum name and the new name in the format of model_name=AnotherName,model_name2=OtherName2."
+                    + " You can also have multiple occurrences of this option.")
+    private List<String> enumNameMappings = new ArrayList<>();
+
     @Option(
             name = {"--openapi-normalizer"},
             title = "OpenAPI normalizer rules",
@@ -492,6 +499,7 @@ public void execute() {
         applyNameMappingsKvpList(nameMappings, configurator);
         applyParameterNameMappingsKvpList(parameterNameMappings, configurator);
         applyModelNameMappingsKvpList(modelNameMappings, configurator);
+        applyEnumNameMappingsKvpList(enumNameMappings, configurator);
         applyOpenAPINormalizerKvpList(openapiNormalizer, configurator);
         applyTypeMappingsKvpList(typeMappings, configurator);
         applyAdditionalPropertiesKvpList(additionalProperties, configurator);

diff --git a/...enapi-generator-core/src/main/java/org/openapitools/codegen/config/GeneratorSettings.java b/...enapi-generator-core/src/main/java/org/openapitools/codegen/config/GeneratorSettings.java
@@ -56,6 +56,7 @@ public final class GeneratorSettings implements Serializable {
     private final Map<String, String> nameMappings;
     private final Map<String, String> parameterNameMappings;
     private final Map<String, String> modelNameMappings;
+    private final Map<String, String> enumNameMappings;
     private final Map<String, String> openapiNormalizer;
     private final Set<String> languageSpecificPrimitives;
     private final Map<String, String> reservedWordsMappings;
@@ -295,6 +296,15 @@ public Map<String, String> getModelNameMappings() {
         return modelNameMappings;
     }
 
+    /**
+     * Gets enum name mappings between an enum name and the new name.
+     *
+     * @return the enum name mappings
+     */
+    public Map<String, String> getEnumNameMappings() {
+        return enumNameMappings;
+    }
+
     /**
      * Gets OpenAPI normalizer rules
      *
@@ -425,6 +435,7 @@ private GeneratorSettings(Builder builder) {
         nameMappings = Collections.unmodifiableMap(builder.nameMappings);
         parameterNameMappings = Collections.unmodifiableMap(builder.parameterNameMappings);
         modelNameMappings = Collections.unmodifiableMap(builder.modelNameMappings);
+        enumNameMappings = Collections.unmodifiableMap(builder.enumNameMappings);
         openapiNormalizer = Collections.unmodifiableMap(builder.openapiNormalizer);
         languageSpecificPrimitives = Collections.unmodifiableSet(builder.languageSpecificPrimitives);
         reservedWordsMappings = Collections.unmodifiableMap(builder.reservedWordsMappings);
@@ -502,6 +513,7 @@ public GeneratorSettings() {
         nameMappings = Collections.unmodifiableMap(new HashMap<>(0));
         parameterNameMappings = Collections.unmodifiableMap(new HashMap<>(0));
         modelNameMappings = Collections.unmodifiableMap(new HashMap<>(0));
+        enumNameMappings = Collections.unmodifiableMap(new HashMap<>(0));
         openapiNormalizer = Collections.unmodifiableMap(new HashMap<>(0));
         languageSpecificPrimitives = Collections.unmodifiableSet(new HashSet<>(0));
         reservedWordsMappings = Collections.unmodifiableMap(new HashMap<>(0));
@@ -572,6 +584,9 @@ public static Builder newBuilder(GeneratorSettings copy) {
         if (copy.getModelNameMappings() != null) {
             builder.modelNameMappings.putAll(copy.getModelNameMappings());
         }
+        if (copy.getEnumNameMappings() != null) {
+            builder.enumNameMappings.putAll(copy.getEnumNameMappings());
+        }
         if (copy.getOpenAPINormalizer() != null) {
             builder.openapiNormalizer.putAll(copy.getOpenAPINormalizer());
         }
@@ -620,6 +635,7 @@ public static final class Builder {
         private Map<String, String> nameMappings;
         private Map<String, String> parameterNameMappings;
         private Map<String, String> modelNameMappings;
+        private Map<String, String> enumNameMappings;
         private Map<String, String> openapiNormalizer;
         private Set<String> languageSpecificPrimitives;
         private Map<String, String> reservedWordsMappings;
@@ -644,6 +660,7 @@ public Builder() {
             nameMappings = new HashMap<>();
             parameterNameMappings = new HashMap<>();
             modelNameMappings = new HashMap<>();
+            enumNameMappings = new HashMap<>();
             openapiNormalizer = new HashMap<>();
             languageSpecificPrimitives = new HashSet<>();
             reservedWordsMappings = new HashMap<>();
@@ -1043,6 +1060,32 @@ public Builder withModelNameMapping(String key, String value) {
             return this;
         }
 
+        /**
+         * Sets the {@code enumNameMappings} and returns a reference to this Builder so that the methods can be chained together.
+         *
+         * @param enumNameMappings the {@code enumNameMappings} to set
+         * @return a reference to this Builder
+         */
+        public Builder withEnumNameMappings(Map<String, String> enumNameMappings) {
+            this.enumNameMappings = enumNameMappings;
+            return this;
+        }
+
+        /**
+         * Sets a single {@code enumNameMappings} and returns a reference to this Builder so that the methods can be chained together.
+         *
+         * @param key   A key for the name mapping
+         * @param value The value of name mapping
+         * @return a reference to this Builder
+         */
+        public Builder withEnumNameMapping(String key, String value) {
+            if (this.enumNameMappings == null) {
+                this.enumNameMappings = new HashMap<>();
+            }
+            this.enumNameMappings.put(key, value);
+            return this;
+        }
+
         /**
          * Sets the {@code openapiNormalizer} and returns a reference to this Builder so that the methods can be chained together.
          *
@@ -1259,6 +1302,7 @@ public boolean equals(Object o) {
                 Objects.equals(getNameMappings(), that.getNameMappings()) &&
                 Objects.equals(getParameterNameMappings(), that.getParameterNameMappings()) &&
                 Objects.equals(getModelNameMappings(), that.getModelNameMappings()) &&
+                Objects.equals(getEnumNameMappings(), that.getEnumNameMappings()) &&
                 Objects.equals(getOpenAPINormalizer(), that.getOpenAPINormalizer()) &&
                 Objects.equals(getLanguageSpecificPrimitives(), that.getLanguageSpecificPrimitives()) &&
                 Objects.equals(getReservedWordsMappings(), that.getReservedWordsMappings()) &&
@@ -1294,6 +1338,7 @@ public int hashCode() {
                 getNameMappings(),
                 getParameterNameMappings(),
                 getModelNameMappings(),
+                getEnumNameMappings(),
                 getOpenAPINormalizer(),
                 getLanguageSpecificPrimitives(),
                 getReservedWordsMappings(),

diff --git a/.../org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt b/.../org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt
@@ -182,6 +182,11 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
      */
     val modelNameMappings = project.objects.mapProperty<String, String>()
 
+    /**
+     * Specifies mappings between an enum name and the new name
+     */
+    val enumNameMappings = project.objects.mapProperty<String, String>()
+
     /**
      * Specifies mappings (rules) in OpenAPI normalizer
      */

diff --git a/...dle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt b/...dle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt
@@ -293,6 +293,13 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
     @Input
     val modelNameMappings = project.objects.mapProperty<String, String>()
 
+    /**
+     * Specifies mappings between the enum name and the new name
+     */
+    @Optional
+    @Input
+    val enumNameMappings = project.objects.mapProperty<String, String>()
+
     /**
      * Specifies mappings (rules) in OpenAPI normalizer
      */
@@ -852,6 +859,12 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
                 }
             }
 
+            if (enumNameMappings.isPresent) {
+                enumNameMappings.get().forEach { entry ->
+                    configurator.addEnumNameMapping(entry.key, entry.value)
+                }
+            }
+
             if (openapiNormalizer.isPresent) {
                 openapiNormalizer.get().forEach { entry ->
                     configurator.addOpenAPINormalizer(entry.key, entry.value)

diff --git a/...api-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java b/...api-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java
@@ -350,6 +350,12 @@ public class CodeGenMojo extends AbstractMojo {
     @Parameter(name = "modelNameMappings", property = "openapi.generator.maven.plugin.modelNameMappings")
     private List<String> modelNameMappings;
 
+    /**
+     * A map of enum names and the new names
+     */
+    @Parameter(name = "enumNameMappings", property = "openapi.generator.maven.plugin.enumNameMappings")
+    private List<String> enumNameMappings;
+
     /**
      * A set of rules for OpenAPI normalizer
      */
@@ -834,6 +840,11 @@ public void execute() throws MojoExecutionException {
                 applyModelNameMappingsKvpList(modelNameMappings, configurator);
             }
 
+            // Apply Enum Name Mappings
+            if (enumNameMappings != null && (configOptions == null || !configOptions.containsKey("enum-name-mappings"))) {
+                applyEnumNameMappingsKvpList(enumNameMappings, configurator);
+            }
+
             // Apply OpenAPI normalizer rules
             if (openapiNormalizer != null && (configOptions == null || !configOptions.containsKey("openapi-normalizer"))) {
                 applyOpenAPINormalizerKvpList(openapiNormalizer, configurator);

diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConfig.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConfig.java
@@ -155,6 +155,8 @@ public interface CodegenConfig {
 
     Map<String, String> modelNameMapping();
 
+    Map<String, String> enumNameMapping();
+
     Map<String, String> openapiNormalizer();
 
     Map<String, String> apiTemplateFiles();

diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
@@ -173,6 +173,8 @@ public class DefaultCodegen implements CodegenConfig {
     protected Map<String, String> parameterNameMapping = new HashMap<>();
     // a map to store the mapping between model name and the name provided by the user
     protected Map<String, String> modelNameMapping = new HashMap<>();
+    // a map to store the mapping between enum name and the name provided by the user
+    protected Map<String, String> enumNameMapping = new HashMap<>();
     // a map to store the rules in OpenAPI Normalizer
     protected Map<String, String> openapiNormalizer = new HashMap<>();
     protected String modelPackage = "", apiPackage = "", fileSuffix;
@@ -1244,6 +1246,11 @@ public Map<String, String> modelNameMapping() {
         return modelNameMapping;
     }
 
+    @Override
+    public Map<String, String> enumNameMapping() {
+        return enumNameMapping;
+    }
+
     @Override
     public Map<String, String> openapiNormalizer() {
         return openapiNormalizer;

diff --git a/.../openapi-generator/src/main/java/org/openapitools/codegen/config/CodegenConfigurator.java b/.../openapi-generator/src/main/java/org/openapitools/codegen/config/CodegenConfigurator.java
@@ -74,6 +74,7 @@ public class CodegenConfigurator {
     private Map<String, String> nameMappings = new HashMap<>();
     private Map<String, String> parameterNameMappings = new HashMap<>();
     private Map<String, String> modelNameMappings = new HashMap<>();
+    private Map<String, String> enumNameMappings = new HashMap<>();
     private Map<String, String> openapiNormalizer = new HashMap<>();
     private Set<String> languageSpecificPrimitives = new HashSet<>();
     private Map<String, String> reservedWordsMappings = new HashMap<>();
@@ -136,6 +137,9 @@ public static CodegenConfigurator fromFile(String configFile, Module... modules)
             if(generatorSettings.getModelNameMappings() != null) {
                 configurator.modelNameMappings.putAll(generatorSettings.getModelNameMappings());
             }
+            if(generatorSettings.getEnumNameMappings() != null) {
+                configurator.enumNameMappings.putAll(generatorSettings.getEnumNameMappings());
+            }
             if(generatorSettings.getOpenAPINormalizer() != null) {
                 configurator.openapiNormalizer.putAll(generatorSettings.getOpenAPINormalizer());
             }
@@ -244,6 +248,12 @@ public CodegenConfigurator addModelNameMapping(String key, String value) {
         return this;
     }
 
+    public CodegenConfigurator addEnumNameMapping(String key, String value) {
+        this.enumNameMappings.put(key, value);
+        generatorSettingsBuilder.withEnumNameMapping(key, value);
+        return this;
+    }
+
     public CodegenConfigurator addOpenAPINormalizer(String key, String value) {
         this.openapiNormalizer.put(key, value);
         generatorSettingsBuilder.withOpenAPINormalizer(key, value);
@@ -440,6 +450,12 @@ public CodegenConfigurator setModelNameMappings(Map<String, String> modelNameMap
         return this;
     }
 
+    public CodegenConfigurator setEnumNameMappings(Map<String, String> enumNameMappings) {
+        this.enumNameMappings = enumNameMappings;
+        generatorSettingsBuilder.withEnumNameMappings(enumNameMappings);
+        return this;
+    }
+
     public CodegenConfigurator setOpenAPINormalizer(Map<String, String> openapiNormalizer) {
         this.openapiNormalizer = openapiNormalizer;
         generatorSettingsBuilder.withOpenAPINormalizer(openapiNormalizer);
@@ -728,6 +744,7 @@ public ClientOptInput toClientOptInput() {
         config.nameMapping().putAll(generatorSettings.getNameMappings());
         config.parameterNameMapping().putAll(generatorSettings.getParameterNameMappings());
         config.modelNameMapping().putAll(generatorSettings.getModelNameMappings());
+        config.enumNameMapping().putAll(generatorSettings.getEnumNameMappings());
         config.openapiNormalizer().putAll(generatorSettings.getOpenAPINormalizer());
         config.languageSpecificPrimitives().addAll(generatorSettings.getLanguageSpecificPrimitives());
         config.reservedWordsMappings().putAll(generatorSettings.getReservedWordsMappings());

diff --git a/...api-generator/src/main/java/org/openapitools/codegen/config/CodegenConfiguratorUtils.java b/...api-generator/src/main/java/org/openapitools/codegen/config/CodegenConfiguratorUtils.java
@@ -159,6 +159,19 @@ public static void applyModelNameMappingsKvp(String modelNameMappings, CodegenCo
         }
     }
 
+    public static void applyEnumNameMappingsKvpList(List<String> enumNameMappings, CodegenConfigurator configurator) {
+        for (String propString : enumNameMappings) {
+            applyEnumNameMappingsKvp(propString, configurator);
+        }
+    }
+
+    public static void applyEnumNameMappingsKvp(String enumNameMappings, CodegenConfigurator configurator) {
+        final Map<String, String> map = createMapFromKeyValuePairs(enumNameMappings);
+        for (Map.Entry<String, String> entry : map.entrySet()) {
+            configurator.addEnumNameMapping(entry.getKey().trim(), entry.getValue().trim());
+        }
+    }
+
     public static void applyOpenAPINormalizerKvpList(List<String> openapiNormalizer, CodegenConfigurator configurator) {
         for (String propString : openapiNormalizer) {
             applyOpenAPINormalizerKvp(propString, configurator);

diff --git a/...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java b/...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java
@@ -1689,6 +1689,10 @@ public String toEnumName(CodegenProperty property) {
 
     @Override
     public String toEnumVarName(String value, String datatype) {
+        if (enumNameMapping.containsKey(value)) {
+            return enumNameMapping.get(value);
+        }
+
         if (value.length() == 0) {
             return "EMPTY";
         }

diff --git a/.../test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml b/.../test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml
@@ -1836,6 +1836,8 @@ components:
         - placed
         - approved
         - delivered
+        - s
+        - S
     OuterEnumInteger:
       type: integer
       enum:

diff --git a/samples/client/petstore/java/okhttp-gson/api/openapi.yaml b/samples/client/petstore/java/okhttp-gson/api/openapi.yaml
@@ -1861,6 +1861,8 @@ components:
       - placed
       - approved
       - delivered
+      - s
+      - S
       nullable: true
       type: string
     OuterEnumInteger:

diff --git a/samples/client/petstore/java/okhttp-gson/docs/OuterEnum.md b/samples/client/petstore/java/okhttp-gson/docs/OuterEnum.md
@@ -11,5 +11,9 @@
 
 * `DELIVERED` (value: `"delivered"`)
 
+* `LOWER_CASE_S` (value: `"s"`)
+
+* `UPPER_CASE_S` (value: `"S"`)
+
 
 
diff --git a/...ient/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/OuterEnum.java b/...ient/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/OuterEnum.java
@@ -33,7 +33,11 @@ public enum OuterEnum {
 
   APPROVED("approved"),
 
-  DELIVERED("delivered");
+  DELIVERED("delivered"),
+
+  LOWER_CASE_S("s"),
+
+  UPPER_CASE_S("S");
 
   private String value;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,5 +11,9 @@

		* `DELIVERED` (value: `"delivered"`)

		* `LOWER_CASE_S` (value: `"s"`)

		* `UPPER_CASE_S` (value: `"S"`)