Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

amakhrov
Copy link
Contributor

@amakhrov amakhrov commented May 15, 2020

In #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

@auto-labeler
Copy link

auto-labeler bot commented May 15, 2020

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

LGTM

@macjohnny
Copy link
Member

@amakhrov thanks for the PR.
could you please update the docs/generators/javascript-flowtyped.md?

@amakhrov
Copy link
Contributor Author

@macjohnny - done!

@macjohnny macjohnny merged commit 56fc5f5 into OpenAPITools:master May 15, 2020
jimschubert added a commit that referenced this pull request May 16, 2020
* master:
  Update username (arun-nalla) (#6319)
  [typescript-axios] Implement useSingleRequestParameter option (#6288)
  [typescript] Remove "v4-compat" value of enumSuffix (#6308)
  Mark swift4 generator as deprecated (#6311)
  Remove @nickmeinhold from Dart technical committee (#6309)
  Migrate Erlang samples to use OAS 3 spec (#6297)
  update dart samples
  Improve parameter documentation (#6092)
  Minor improvements to `plantuml` doc generator (#6298)
  undo changes to petstore.yaml oas3.0 (#6299)
  Allow passing progress callbacks through client methods. (#6261)
  Create method to json (#6111)
@amakhrov amakhrov deleted the typescript/remove-legacy-enum-naming branch May 16, 2020 18:25
@wing328 wing328 added this to the 5.0.0 milestone Jul 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants