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(swagger): Query Enums with isArray and enumName have type 'array' in schema #2870

Merged

Conversation

arkraft
Copy link
Contributor

@arkraft arkraft commented Mar 9, 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?

I have a reproduction repository: https://github.com/arkraft/enum-array-repro

If a define a query like this:

enum LettersEnum {
  A = 'a',
  B = 'b',
  C = 'c',
}

@ApiQuery({
    name: 'letters',
    enum: LettersEnum,
    enumName: 'LettersEnum',
    isArray: true,
  })
  getHello(@Query('letters') letters: LettersEnum[]): string {

the final array should be of type string and the query param should be of type array. Instead, both of them are strings:

image
"components": {
        "schemas": {
            "LettersEnum": {
                "type": "array",
                "enum": [
                    "a",
                    "b",
                    "c"
                ]
            }
        }
    }

What is the new behavior?

With this PR, the extracted enum will have the correct enum type

"components": {
        "schemas": {
            "LettersEnum": {
                "type": "string",
                "enum": [
                    "a",
                    "b",
                    "c"
                ]
            }
        }
    }

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

I edited the enum tests to include the @Query' and '@Param in the request itself, because I believe, this is the correct use case for them. I would also revert the change, if it is not wanted

@kamilmysliwiec kamilmysliwiec merged commit d3bad9d into nestjs:master Jul 1, 2024
@kamilmysliwiec
Copy link
Member

lgtm

@arkraft arkraft deleted the fix/array-enums-queries-or-params branch July 4, 2024 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants