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

Fix stringifying of ~= in enums #7460

Merged
merged 1 commit into from
Sep 25, 2020

Conversation

aidanhs
Copy link
Contributor

@aidanhs aidanhs commented Sep 20, 2020

Fixes #4069

The jira openapi spec includes "~=" as a value of an enum. This change ensures it gets stringified correctly.

You can see the problem by performing Rust codegen on https://developer.atlassian.com/cloud/jira/platform/swagger.v3.json:

$ java -jar openapi-generator-cli.jar generate -i $jiraspecpath -o jira-openapi -g rust --library reqwest --additional-properties packageName=jira-openapi
$ grep -A100 'pub enum Operator' jira-openapi/src/models/field_value_clause.rs
pub enum Operator {
    #[serde(rename = "=")]
    Equal,
    #[serde(rename = "!=")]
    Not_Equal,
    #[serde(rename = ">")]
    Greater_Than,
    #[serde(rename = "<")]
    Less_Than,
    #[serde(rename = ">=")]
    Greater_Than_Or_Equal_To,
    #[serde(rename = "<=")]
    Less_Than_Or_Equal_To,
    #[serde(rename = "in")]
    _In,
    #[serde(rename = "not in")]
    Not_in,
    #[serde(rename = "~")]
    Tilde,
    #[serde(rename = "~=")]
    ,
    #[serde(rename = "is")]
    Is,
    #[serde(rename = "is not")]
    Is_not,
}

The , on a line by itself is not valid Rust. With this change, that line becomes Tilde_Equal,

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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

LGTM

@wing328 wing328 added this to the 5.0.0 milestone Sep 25, 2020
@wing328 wing328 merged commit 9778d97 into OpenAPITools:master Sep 25, 2020
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Sep 25, 2020
* master: (2170 commits)
  [ci][test] Fix samples (OpenAPITools#7509)
  [bug][Java] Honor instantiationMap for default values for array, map, set (OpenAPITools#4982)
  Fix stringifying of ~= (OpenAPITools#7460)
  minor formatting change (OpenAPITools#7503)
  [ruby] Fix generation when generateAliasAsModel is enabled (OpenAPITools#7419)
  [sonar][ci] Fixes some new recommended "bug" fixes found via Sonar (OpenAPITools#7508)
  Add option to set recursion limit (OpenAPITools#7491)
  regenerate java pkmst petstore samples (OpenAPITools#7502)
  fix issue without http signature auth (OpenAPITools#7504)
  [ruby] Support for per-operation servers (OpenAPITools#7415)
  Add a link to react native tutorial (OpenAPITools#7505)
  update of Objective-C model-body.mustache to support discriminator.mappedModels (OpenAPITools#7471)
  update samples
  [ci] Sonar bug fixes (OpenAPITools#7497)
  fixed the backslash issue (OpenAPITools#7492)
  Fix the range check condition (OpenAPITools#7482)
  [batch] Option to clean files before generation (OpenAPITools#7465)
  [java][groovy] Fix mangled src paths in outputs on Windows (OpenAPITools#7487)
  remove haskell stack installation in shippable ci (OpenAPITools#7481)
  remove hardcoded PetApi (OpenAPITools#7483)
  ...
jimschubert added a commit to david1601/openapi-generator that referenced this pull request Sep 28, 2020
…or-extension-x-spring-paginated

* master: (29 commits)
  [Core, HTML2] Rendered docs are incomplete (OpenAPITools#7510)
  [C][Client]Support data callback function (OpenAPITools#7467)
  [typescript-axios] replace optional chaining (OpenAPITools#7476)
  [typescript-axios] fix refining `query` (OpenAPITools#7475)
  [powershell] Updated the Api doc with httpsiging script snippet. (OpenAPITools#7499)
  [go][client] Fix API docs example generation (OpenAPITools#7489)
  [ci][test] Fix samples (OpenAPITools#7509)
  [bug][Java] Honor instantiationMap for default values for array, map, set (OpenAPITools#4982)
  Fix stringifying of ~= (OpenAPITools#7460)
  minor formatting change (OpenAPITools#7503)
  [ruby] Fix generation when generateAliasAsModel is enabled (OpenAPITools#7419)
  [sonar][ci] Fixes some new recommended "bug" fixes found via Sonar (OpenAPITools#7508)
  Add option to set recursion limit (OpenAPITools#7491)
  regenerate java pkmst petstore samples (OpenAPITools#7502)
  fix issue without http signature auth (OpenAPITools#7504)
  [ruby] Support for per-operation servers (OpenAPITools#7415)
  Add a link to react native tutorial (OpenAPITools#7505)
  update of Objective-C model-body.mustache to support discriminator.mappedModels (OpenAPITools#7471)
  update samples
  [ci] Sonar bug fixes (OpenAPITools#7497)
  ...
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.

[BUG] Generator creates invalid code on validated schema when an enum contains ~=
2 participants