Skip to content

Give enums valid names when specified with x-enum-varnames#10325

Open
UnsolvedCypher wants to merge 1 commit intoOpenAPITools:masterfrom
UnsolvedCypher:6.0.x
Open

Give enums valid names when specified with x-enum-varnames#10325
UnsolvedCypher wants to merge 1 commit intoOpenAPITools:masterfrom
UnsolvedCypher:6.0.x

Conversation

@UnsolvedCypher
Copy link

@UnsolvedCypher UnsolvedCypher commented Sep 4, 2021

This changes how x-enum-varnames behaves. Issue #3246 already describes the problem quite well, but to summarize, the current codegen just takes the value specified by x-enum-varnames and sets the enum variable name to it. This causes the generation of bad code when the specified name isn't a valid variable name, such as because it contains spaces. Additionally, different languages have different conventions for enum names, so for you may want Partly cloudy to generate PARTLY_CLOUDY in Java but PartyCloudy in TypeScript.

This change now passes the user-specified name to the language-specific toEnumVarName function for processing, so that the generated variable name is legal for the target language, and so that it conforms to language conventions or any other generator-specific settings that have been set. This is what issue #3246 refers to as "option 1" for a fix.

If there is any other information I can provide, please let me know 😃

Fix #3246

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Copy link

@joey-yoonsung joey-yoonsung left a comment

Choose a reason for hiding this comment

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

Thanks 👍 That's what I want!

@UnsolvedCypher
Copy link
Author

Hi @agilob , does this look ready to merge or do you have any concerns?

@UnsolvedCypher
Copy link
Author

Hi @wing328 could you please take a look at this when you have a chance? It would be great to get it merged!

@wing328 wing328 changed the base branch from 6.0.x to master October 15, 2022 08:51
@UnsolvedCypher
Copy link
Author

Hi @wing328, I believe this is good to merge. Please let me know if you would like any changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] x-enum-varnames is underspecified

3 participants