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: number enum generated schema type #2238

Merged
merged 1 commit into from
Feb 6, 2023

Conversation

habiiev
Copy link
Contributor

@habiiev habiiev commented Jan 11, 2023

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

Currently, if you create a number enum property like this:

@ApiParam({ enum: [1, 2, 3] })

It will then generate a correct schema for this param:

{
  "type": "number",
  "enum": [1, 2, 3]
}

But if you add an “enumName“ parameter, so that the enum will get its own schema entry like this:

@ApiParam({ enum: [1, 2, 3], enumName: "ParamEnumName" })

It will change the type of the enum in the schema from 'number' to 'string':

{
  "ParamEnumName": {
    "type": "string",
    "enum": [
      1,
      2,
      3
    ]
  }
}

What is the new behavior?

I made it so it saves the type, if is was given before.

So if we take our previous example:

@ApiParam({ enum: [1, 2, 3], enumName: "ParamEnumName" })

It will now generate a correct schema for this enum:

{
  "ParamEnumName": {
    "type": "number",
    "enum": [
      1,
      2,
      3
    ]
  }
}

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@kamilmysliwiec kamilmysliwiec merged commit 4f786b1 into nestjs:master Feb 6, 2023
@kamilmysliwiec
Copy link
Member

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants