Merge branch 'jessemyers-array-format-placement'

nestjs · Mar 19, 2021 · 86ee0a0 · 86ee0a0
2 parents 7703755 + 263a7b3
commit 86ee0a0
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 8 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -102,7 +102,8 @@
           "tags": {
             "type": "array",
             "items": {
-              "type": "string"
+              "type": "string",
+              "format": "uri"
             }
           },
           "createdAt": {

diff --git a/e2e/src/cats/dto/create-cat.dto.ts b/e2e/src/cats/dto/create-cat.dto.ts
@@ -15,6 +15,7 @@ export class CreateCatDto {
   readonly breed: string;
 
   @ApiProperty({
+    format: 'uri',
     type: [String]
   })
   readonly tags?: string[];

diff --git a/lib/services/schema-object-factory.ts b/lib/services/schema-object-factory.ts
@@ -8,7 +8,8 @@ import {
   keyBy,
   mapValues,
   omit,
-  omitBy
+  omitBy,
+  pick
 } from 'lodash';
 import { DECORATORS } from '../constants';
 import { getTypeIsArrayTuple } from '../decorators/helpers';
@@ -424,15 +425,22 @@ export class SchemaObjectFactory {
     type: string | Record<string, any>
   ): SchemaObjectMetadata {
     const keysToRemove = ['type', 'enum'];
+    const keysToMove = [
+      'format',
+      'maximum',
+      'maxLength',
+      'minimum',
+      'minLength',
+      'pattern'
+    ];
+    const movedProperties = pick(metadata, keysToMove);
     const schemaHost = {
-      ...omit(metadata, keysToRemove),
+      ...omit(metadata, [...keysToRemove, ...keysToMove]),
       name: metadata.name || key,
       type: 'array',
       items: isString(type)
-        ? {
-            type
-          }
-        : { ...type }
+        ? { type, ...movedProperties }
+        : { ...type, ...movedProperties }
     };
     schemaHost.items = omitBy(schemaHost.items, isUndefined);
     return schemaHost as unknown;

diff --git a/test/services/fixtures/create-user.dto.ts b/test/services/fixtures/create-user.dto.ts
@@ -46,7 +46,8 @@ export class CreateUserDto {
 
   @ApiProperty({
     type: String,
-    isArray: true
+    isArray: true,
+    format: 'uri'
   })
   urls: string[];
 

diff --git a/test/services/schema-object-factory.spec.ts b/test/services/schema-object-factory.spec.ts
@@ -148,6 +148,7 @@ describe('SchemaObjectFactory', () => {
           },
           urls: {
             items: {
+              format: 'uri',
               type: 'string'
             },
             type: 'array'