Merge pull request #3169 from nestjs/fix/expose-self-required-3163

fix: expose self required attribute for objects
nestjs · Nov 15, 2024 · bbd3380 · bbd3380
2 parents eadd76b + 353f5fd
commit bbd3380
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -1690,6 +1690,7 @@
           "createdAt",
           "urls",
           "_options",
+          "rawDefinition",
           "enum",
           "enumArr",
           "enumWithRef",

diff --git a/e2e/src/cats/classes/cat.class.ts b/e2e/src/cats/classes/cat.class.ts
@@ -57,7 +57,8 @@ export class Cat {
         example: 400
       }
     },
-    required: ['name', 'status']
+    required: ['name', 'status'],
+    selfRequired: true
   })
   rawDefinition?: Record<string, any>;
 

diff --git a/lib/interfaces/schema-object-metadata.interface.ts b/lib/interfaces/schema-object-metadata.interface.ts
@@ -1,6 +1,6 @@
 import { Type } from '@nestjs/common';
 import { EnumSchemaAttributes } from './enum-schema-attributes.interface';
-import { SchemaObject } from './open-api-spec.interface';
+import { ReferenceObject, SchemaObject } from './open-api-spec.interface';
 
 export type EnumAllowedTypes =
   | any[]
@@ -38,4 +38,12 @@ export type SchemaObjectMetadata =
       type: 'object';
       properties: Record<string, SchemaObjectMetadata>;
       required?: string[];
+      selfRequired?: boolean;
+    } & SchemaObjectCommonMetadata)
+  | ({
+      type: 'object';
+      properties?: Record<string, SchemaObjectMetadata>;
+      additionalProperties: SchemaObject | ReferenceObject | boolean;
+      required?: string[];
+      selfRequired?: boolean;
     } & SchemaObjectCommonMetadata);