Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !6308

[typescript] Remove "v4-compat" value of enumSuffix

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/crunchbase/typescript/remove-legacy-enum-naming into master May 15, 2020
  • Overview 0
  • Commits 4
  • Pipelines 0
  • Changes 16

Created by: amakhrov

In https://github.com/OpenAPITools/openapi-generator/pull/5138 , a new enumSuffix option was introduced. Before that the logic for generating enum names was inconsistent across generators / different modes. So in order to keep backward compatibility, a special v4-compat value for this option was introduced (and used by default) to simulate the original behavior as of pre v4.2.3 .

Now, for 5.0 release we can get rid of this v4-compat mode. Consumers can still get the original behavior by setting enumSuffix to the value they need in their project.

The new default value of enumSuffix is "Enum". It results in minimal changes in the generated samples - most of the sample projects were already configured in a way that emited the same enum names as with the new default.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • 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).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @nicokoenig @topce @akehir @petejohansonxo

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/crunchbase/typescript/remove-legacy-enum-naming