Skip to content
GitLab

Add isEnumRef, isEnumOrRef to CodegenProperty

Merged William Cheng requested to merge property-enum-enhancement into master

To address the bug that isEnum is not set properly when the enum is a reference (instead of an inline schema) in a codegen property, I've added isEnumRef and also isEnumOrRef mustache tags to provide a migration path to address the issue.

Why not simply just fix it like https://github.com/OpenAPITools/openapi-generator/pull/9526? We appreciate the fix but the problem is that it impacts lots of generators and some output won't even compile/work any more: https://gist.github.com/wing328/d8ef17e0b884ea821f2c7a1218ab368f

isEnumRef is set to true if the it's a $ref and the $ref is an enum. isEnumOrRef is set to true if isEnumRef or isEnum is set to true

I've updated r templates to use isEnumOrRef and there's no change in the output.

I've updated powershell templates to use isEnumOrRef, which results in a fix.

Some tests in this PR comes from https://github.com/OpenAPITools/openapi-generator/pull/13389 (credit @rivancic)

After this PR is merged, users can update the template and/or generator accordingly to ensure the output works using isEnumOrRef or isEnumRef and of course we welcome PRs to apply these fix upstream in this official repo.

Related PRs/issues:

cc @aymanbagabas @questionableque @snowe2010 @oszust002 @rivancic @flowstef @LukeMarlin

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 (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

cc @OpenAPITools/generator-core-team