Read thecontribution guidelines.
Ran the shell script under./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh and./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.
Filed the PR against thecorrect branch:master,3.3.x,4.0.x. Default:master.
Copied thetechnical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

(details of the change, additional tests that have been done, reference to the issue for tracking, etc)

For issue#893
Add "x-enum-varnames" vendor extension to control names of generated enum properties.

add "x-enum-varnames" extension to control the naming of the enum par…

cfd1f4c

…ameter nameOpenAPITools#893

osjupiter force-pushed thefeature/xenumname branch froma16d0ba tocfd1f4cCompare

August 28, 2018 14:38

jmini reviewed

Aug 29, 2018

View reviewed changes

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

		privatevoidupdateEnumVarsWithExtensions(List<Map<String,Object>>enumVars,Map<String,Object>vendorExtensions) {
		if (vendorExtensions !=null &&vendorExtensions.containsKey("x-enum-varnames")) {
		List<String>alias = (List<String>)vendorExtensions.get("x-enum-varnames");
		if (alias.size() ==enumVars.size()) {

Copy link

Member

jminiAug 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Maye you could just log a warning if the sizes do not match.

In my opinion it is OK to still change the first two defined names in a case like this:

EnumProp:type:stringenum:          -a          -b          -cx-enum-varnames:          -FOO          -BAR

Copy link

ContributorAuthor

osjupiterAug 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I see.
Then I'll make changes to allow to set different number of elements from target enum.

jmini mentioned this pull request

Aug 29, 2018

support integer enum#701

Closed

allow to set different size from target enum

029a8e2

jmini changed the title~~add "x-enum-varnames" extension to control enum varname~~[all] add "x-enum-varnames" extension to control enum varname

Aug 30, 2018

jmini added this to the3.2.3 milestone

Aug 30, 2018

jmini added the Enhancement: Feature label

Aug 30, 2018

jmini approved these changes

Aug 30, 2018

View reviewed changes

Copy link

Member

jmini commentedAug 30, 2018

Tested with a java client generator with:

EnumWithCustomName:type:integerformat:int32enum:        -1        -2x-enum-varnames:        -FOO        -BAR

The produced codeEnumWithCustomName.java looks good.

jmini merged commit62abd51 intoOpenAPITools:master

Aug 30, 2018

Copy link

Member

jmini commentedAug 30, 2018

Thank you for this great contribution!

jmini mentioned this pull request

Aug 30, 2018

Invalid enum var names are generated by multi-byte characters#893

Closed

Copy link

Member

wing328 commentedAug 30, 2018

@osjupiter thanks for the PR, which has been included in the v3.2.3 release:https://twitter.com/oas_generator/status/1035200785066254336

jmini added a commit to jmini/openapi-experiments that referenced this pull request

Sep 1, 2018

Teepots: Add enum with custom name.

570eee6

Test case forOpenAPITools/openapi-generator#917

Copy link

Contributor

phstudy commentedSep 26, 2018•
edited
Loading

The codegen ofinteger type enum model works fine. However, If I reference theinteger type enum in other model, it always will be treat as a outer class enum.

This issue was fixed in#1120.

A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request

Feb 27, 2019

[all] add "x-enum-varnames" extension to control enum varname (OpenAP…

12278b9

…ITools#917)* add "x-enum-varnames" extension to control the naming of the enum parameter name* allow to set different size from target enum

kevinoid mentioned this pull request

Jun 29, 2019

[BUG] x-enum-varnames is underspecified#3246

Open

Copy link

akhileshnair08 commentedAug 4, 2020•
edited
Loading

ABCEnum:
enum:
-{0,"aum"}
-{1,"gautham"}
-{2,"Buddha"}
x-enum-varnames:
- AUM
- GAUTHAM
- BUDDHA
type: object
properties:
num_value:
type: integer
format: int32
str_value:
type: string

Why is this not working???
getting below error:
unexpected error in Open-API generation (org.openapitools:openapi-generator-maven-plugin:4.1.3:generate:default:generate-sources)