fix: @ApiSchema inheritance

Ensure the correct @ApiSchema name is used when inheriting from a base class.
nestjs · Nov 13, 2024 · f8ba5ef · f8ba5ef
1 parent 7acedba
commit f8ba5ef
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/lib/services/schema-object-factory.ts b/lib/services/schema-object-factory.ts
@@ -292,7 +292,7 @@ export class SchemaObjectFactory {
       return type.name;
     }
 
-    const schemaName = customSchema[0].name;
+    const schemaName = customSchema[customSchema.length - 1].name;
     return schemaName ?? type.name;
   }
 

diff --git a/lib/utils/get-schema-path.util.ts b/lib/utils/get-schema-path.util.ts
@@ -21,7 +21,7 @@ function getSchemaNameByClass(target: Function): string {
     return target.name;
   }
 
-  return customSchema[0].name ?? target.name;
+  return customSchema[customSchema.length - 1].name ?? target.name;
 }
 
 export function refs(...models: Function[]) {

diff --git a/test/services/schema-object-factory.spec.ts b/test/services/schema-object-factory.spec.ts
@@ -412,6 +412,24 @@ describe('SchemaObjectFactory', () => {
       expect(Object.keys(schemas)).toContain('UpdateUserDto');
     });
 
+    it('should override the schema name of base class', () => {
+      @ApiSchema({
+        name: 'CreateUser'
+      })
+      class CreateUserDto {}
+
+      @ApiSchema({
+        name: 'UpdateUser'
+      })
+      class UpdateUserDto extends CreateUserDto {}
+
+      const schemas: Record<string, SchemasObject> = {};
+
+      schemaObjectFactory.exploreModelSchema(UpdateUserDto, schemas);
+
+      expect(Object.keys(schemas)).toContain('UpdateUser');
+    });
+
     it('should include extension properties', () => {
       @ApiExtension('x-test', 'value')
       class CreatUserDto {