Merge pull request #3031 from danielsharvey/feature/example-support

feat: Add schema support for "example" annotations
nestjs · Sep 17, 2024 · 391abb3 · 391abb3
2 parents 00a6b80 + bd75d0a
commit 391abb3
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 5 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -293,6 +293,7 @@
               "title": "Page",
               "format": "int32",
               "default": 0,
+              "example": 123,
               "type": "number"
             }
           },
@@ -302,6 +303,10 @@
             "in": "query",
             "schema": {
               "nullable": true,
+              "example": [
+                "sort1",
+                "sort2"
+              ],
               "type": "array",
               "items": {
                 "type": "string"
@@ -490,6 +495,7 @@
               "title": "Page",
               "format": "int32",
               "default": 0,
+              "example": 123,
               "type": "number"
             }
           },
@@ -499,6 +505,10 @@
             "required": true,
             "schema": {
               "nullable": true,
+              "example": [
+                "sort1",
+                "sort2"
+              ],
               "type": "array",
               "items": {
                 "type": "string"

diff --git a/e2e/src/cats/dto/pagination-query.dto.ts b/e2e/src/cats/dto/pagination-query.dto.ts
@@ -14,13 +14,15 @@ export class PaginationQuery {
     exclusiveMaximum: true,
     exclusiveMinimum: true,
     format: 'int32',
-    default: 0
+    default: 0,
+    example: 123
   })
   page: number;
 
   @ApiProperty({
     name: '_sortBy',
-    nullable: true
+    nullable: true,
+    example: ['sort1', 'sort2']
   })
   sortBy: string[];
 

diff --git a/lib/services/swagger-types-mapper.ts b/lib/services/swagger-types-mapper.ts
@@ -157,7 +157,8 @@ export class SwaggerTypesMapper {
       'format',
       'pattern',
       'nullable',
-      'default'
+      'default',
+      'example'
     ];
   }
 }
diff --git a/test/plugin/fixtures/project/cats/dto/pagination-query.dto.ts b/test/plugin/fixtures/project/cats/dto/pagination-query.dto.ts
@@ -14,13 +14,15 @@ export class PaginationQuery {
     exclusiveMaximum: true,
     exclusiveMinimum: true,
     format: 'int32',
-    default: 0
+    default: 0,
+    example: 123
   })
   page: number;
 
   @ApiProperty({
     name: '_sortBy',
-    nullable: true
+    nullable: true,
+    example: ['sort1', 'sort2']
   })
   sortBy: string[];