[feature] Add option to disable stripping of common prefix enum

[johnflanigan]

PR detail

• Add enableEnumPrefixRemoval option to toggle whether enum prefixes are stripped. Currently the prefixes are stripped so I have this option set to true by default.
  • Close [REQ] Option to disable stripping of common enum prefix #2624
• Add tests to DefaultCodegenTest to test functionality and verify default behavior has not changed.

PR checklist

• [x ] Read the contribution guidelines.
• [ x] If contributing template-only or documentation-only changes which will change sample output, build the project before.
• [ x] Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
• [ x] File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
• [ x] Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @ircecho @swipesight @jaumard @nickmeinhold @athornz @amondnet

I'm not very familiar with open source contributing so I'll apologize in advance if anything is not correct. Happy to address any problems or things I should do differently.

[auto-labeler]

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[amakhrov]

Looks like a couple of similar boolean options that exist in codegen use slightly different naming: REMOVE_OPERATION_ID_PREFIX, STRIP_PACKAGE_NAME, etc
What do you think about making this new option to follow the same pattern? I.e. REMOVE_ENUM_PREFIX. Or, for better clarity, even REMOVE_ENUM_VALUE_PREFIX

[johnflanigan]

Sure, that change makes sense to me. I've updated the PR to use REMOVE_ENUM_VALUE_PREFIX.

[johnflanigan]

I noticed DartClientCodegen and PythonClientExperimentalCodegen follow a similar pattern of calling findCommonPrefixOfVars to find the common prefix and then remove it. Should this change be made there as well to keep behavior consistent across languages?

[johnflanigan]

The same pattern to create enumVars appeared to be used in multiple places so I extracted it into a method called buildEnumVars. The only place that seemed slightly different was in the DartClientCodegen where isString wasn't set in the map so I'm hoping that adding it doesn't break anything Dart specific.

[amakhrov]

@johnflanigan nice job on getting rid of duplicate code!

Looks like an important thing missing in the PR is that it doesn't @mention the technical committee - so chances are the maintainers won't notice it.

[johnflanigan]

Thanks, good point! I didn't mention anyone initially since it wasn't targeting a specific language, but I'll copy the Dart technical committee since its making a change to the DartClientCodegen now.

[johnflanigan]

Is anyone available to review this change?

cc OpenAPI Generator Core Team: @wing328 @jimschubert @cbornet @ackintosh @jmini @etherealjoy

[jimschubert]

I think this looks good. I'll give it a little longer for review from others on the core team due to the new getter/setter on CodegenConfig.

[jimschubert]

Thanks for the PR. There doesn't seem to be anymore comments, so I'm merging.

[air237]

I'd like to set the removeEnumValuePrefix to false in the pom like this:

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>4.3.0-SNAPSHOT</version>
    <configuration>
        <removeEnumValuePrefix>false</removeEnumValuePrefix>

The property value haven't changed, the prefix is still trimmed.
How can I set it correctly?

[johnflanigan]

@air237 Can you try setting it in additionalProperties under configuration. I'm not too familiar with the Maven plugin but I think it would be something like this based on the plugin's README:

<configuration>
    <additionalProperties>removeEnumValuePrefix=false</additionalProperties>
</configuration>

I just tested using the Gradle plugin which I'm more familiar with and this worked:

openApiGenerate {
    generatorName = "java"
    inputSpec = "$rootDir/pet-store.yaml".toString()
    additionalProperties = [
            removeEnumValuePrefix: "false"
    ]
}

[johnflanigan]

@air237 Were you able to get it working? If there are problems with it, I'm happy to look into it further!

[air237]

@johnflanigan Thank you for your prompt reply. I was able to get it working. I just tested it. Thanks!

[wing328]

@johnflanigan thanks for the PR, which has been included in the 4.3.0 release: https://twitter.com/oas_generator/status/1243455743937789952

[unexist]

I wonder, why is this issue circularly linked without any proper docs? Is it really fixed right now? Version? What is correct syntax to prevent this behaviour?

Edit: I found a way that works properly for me, use the code from above inside of the plugin config - not execution config:

<plugin>
        <!-- Snip -->
    <configuration>
        <additionalProperties>removeEnumValuePrefix=false</additionalProperties>
    </configuration>
    <executions>
        <execution>
            <!-- Snip -->
            <configuration>
                <!-- Snip -->
            </configuration>
        </execution>
    </execution>
</plugin>

[stevegoossens]

@unexist thanks for posting the working maven plugin config for using removeEnumValuePrefix !

[gl0b3]

It's not working for me in version 3. Has it been ported?