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: enum array when using enumName #2929

Conversation

deongroenewald
Copy link
Contributor

@deongroenewald deongroenewald commented Apr 25, 2024

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?

If you create an ApiQuery parameter, which has an enum, enumName and isArray: true, like this:

@ApiQuery({
  name: 'page',
  enum: ['a', 'b', 'c'],
  enumName: 'QueryEnum',
  isArray: true
})

The type in the schema will be array instead of the intended type for the items, e.g. string:

"QueryEnum": {
  "type": "array",
  "enum": ["a", "b", "c"]
}

Issue Number: N/A

What is the new behavior?

It will now generate the correct type for the items schema:

"QueryEnum": {
  "type": "string",
  "enum": ["a", "b", "c"]
}

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

The `type` in the items schema incorrectly resolves to `array` instead of the correct `type` for the items.
@kamilmysliwiec
Copy link
Member

Duplicate #2870

@deongroenewald deongroenewald deleted the fix/is-array-with-enum-name branch July 15, 2024 15:27
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.

2 participants