test: add e2e test to ensure proper enum schema generation #2179

nestjs · Oct 28, 2024 · 31eb40f · 31eb40f
1 parent 882c0d4
commit 31eb40f
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -442,6 +442,22 @@
               "type": "object"
             }
           },
+          {
+            "name": "catBreeds",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "persian",
+                  "siamese",
+                  "maine-coon"
+                ]
+              }
+            }
+          },
           {
             "name": "x-tenant-id",
             "in": "header",

diff --git a/e2e/src/cats/cats.controller.ts b/e2e/src/cats/cats.controller.ts
@@ -18,6 +18,7 @@ import { CatsService } from './cats.service';
 import { Cat } from './classes/cat.class';
 import { CreateCatDto } from './dto/create-cat.dto';
 import { LettersEnum, PaginationQuery } from './dto/pagination-query.dto';
+import { CatBreed } from './enums/cat-breed.enum';
 
 @ApiSecurity('basic')
 @ApiBearerAuth()
@@ -104,6 +105,11 @@ export class CatsController {
     { lang: 'JavaScript', source: "console.log('Hello World');" }
   ])
   @ApiExtension('x-multiple', { test: 'test' })
+  @ApiQuery({
+    name: 'catBreeds',
+    enum: CatBreed,
+    isArray: true
+  })
   @ApiTags('tag1')
   @ApiTags('tag2')
   findAll(@Query() paginationQuery: PaginationQuery) {}

diff --git a/e2e/src/cats/enums/cat-breed.enum.ts b/e2e/src/cats/enums/cat-breed.enum.ts
@@ -0,0 +1,5 @@
+export enum CatBreed {
+  Persian = 'persian',
+  Siamese = 'siamese',
+  MaineCoon = 'maine-coon'
+}