openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

fix: can't access enum within data class of same name

Open tien opened this issue 2 years ago • 6 comments

Use fully qualified name for enum to distinguish from class with possible same name

PR checklist

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) 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*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [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.

tien avatar Dec 18 '23 09:12 tien

can you share a sample spec to reproduce the issue?

ussually we escape the "reserved words" instead of using fully-qualified name.

wing328 avatar Dec 21 '23 11:12 wing328

There's already this issue here containing the steps needed to reproduce this

I'm not sure what is the best path to solve this, but this is just what I'm using currently since it's the most straight forward one, and is guaranteed to work in every scenario.

tien avatar Dec 25 '23 00:12 tien

@wing328 is this still relevant?

tien avatar May 12 '24 14:05 tien

as a workaorund, what about using model name mapping feature to map the classname to something else to workaround the issue for the time being?

https://github.com/openapitools/openapi-generator/blob/master/docs/customization.md#name-mapping

wing328 avatar May 13 '24 12:05 wing328

@wing328 It's not urgent since I'm using the workaround from this PR. Just saying other people might face the same issue. Also, this is a matter of style, of course. But I think for generated code, it's fine to use the fully qualified name. Verbosity doesn't really matter for codegen & this will eliminate any potential issue with conflicts.

tien avatar May 13 '24 13:05 tien

@tien thanks again for the PR.

But I think for generated code, it's fine to use the fully qualified name

We know some are ok with fully qualified name but others do not.

can you please try the model name mapping option? it should fix/workaround the issue

wing328 avatar May 13 '24 13:05 wing328