add limit as required (#659)

Co-authored-by: Jerry Wang <jerryappleid761208@gmail.com>
bcgov · Oct 4, 2024 · 1724bc9 · 1724bc9
1 parent 080a994
commit 1724bc9
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/apps/api/src/applicant/dto/ienuser-filter.dto.ts b/apps/api/src/applicant/dto/ienuser-filter.dto.ts
@@ -1,7 +1,7 @@
-import { IsNumberString, IsOptional, IsString, IsDateString } from 'class-validator';
+import { IsNumberString, IsOptional, IsString, IsDateString, IsNotEmpty } from 'class-validator';
 import { ApiPropertyOptional } from '@nestjs/swagger';
 
-export class IENUserFilterAPIDTO {
+export class IENUserBaseFilterAPIDTO {
   @ApiPropertyOptional({
     description: 'Start date for range',
     example: '2020-01-01',
@@ -25,17 +25,30 @@ export class IENUserFilterAPIDTO {
   @IsString()
   organization?: string;
 
+  @ApiPropertyOptional({
+    description: 'Skip the number of results',
+  })
+  @IsOptional()
+  @IsNumberString()
+  skip?: number;
+}
+export class IENUserFilterAPIDTO extends IENUserBaseFilterAPIDTO {
   @ApiPropertyOptional({
     description: 'Limit the number of results',
   })
   @IsOptional()
   @IsNumberString()
   limit?: number;
+}
 
+/**
+ * As class-validator does not override the decorator @IsOptional when override the parent class, we need to create a separate class for the filter with limit
+ */
+export class IENUserLimitFilterAPIDTO extends IENUserBaseFilterAPIDTO {
   @ApiPropertyOptional({
-    description: 'Skip the number of results',
+    description: 'Limit the number of results',
   })
-  @IsOptional()
+  @IsNotEmpty()
   @IsNumberString()
-  skip?: number;
+  limit!: number;
 }
diff --git a/apps/api/src/applicant/external-api.controller.ts b/apps/api/src/applicant/external-api.controller.ts
@@ -24,6 +24,7 @@ import { IENUserFilterAPIDTO, SyncApplicantsResultDTO } from './dto';
 import { AuthGuard } from '../auth/auth.guard';
 import { JWTGuard } from 'src/auth/jwt.guard';
 import { ApplicantSyncRO } from './ro/sync.ro';
+import { IENUserLimitFilterAPIDTO } from './dto/ienuser-filter.dto';
 
 @Controller('external-api')
 @ApiTags('External API data process')
@@ -140,7 +141,7 @@ export class ExternalAPIController {
   @UseGuards(JWTGuard)
   @ApiBearerAuth()
   @Get('/applicants')
-  async getApplicants(@Query() filter: IENUserFilterAPIDTO): Promise<ApplicantSyncRO[]> {
+  async getApplicants(@Query() filter: IENUserLimitFilterAPIDTO): Promise<ApplicantSyncRO[]> {
     return await this.externalAPIService.getApplicants(filter);
   }
 }