Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(search): publish limit and offset as integer query parameters

Yudhi Armyndharisf63a9d4943c7
diff --git a/openapi.json b/openapi.json
index dca5dff26..a94314806 100644
--- a/openapi.json
+++ b/openapi.json
@@ -17289,7 +17289,7 @@
"description": "Max hits to return",
"schema": {
"minimum": 1,
- "type": "number"
+ "type": "integer"
}
},
{
@@ -17300,7 +17300,7 @@
"schema": {
"minimum": 0,
"maximum": 100000,
- "type": "number"
+ "type": "integer"
}
}
],
diff --git a/src/modules/search/search.controller.spec.ts b/src/modules/search/search.controller.spec.ts
index 20659fd77..ae14b1172 100644
--- a/src/modules/search/search.controller.spec.ts
+++ b/src/modules/search/search.controller.spec.ts
@@ -1,4 +1,5 @@
import { BadRequestException, NotImplementedException } from '@nestjs/common';
+import { DECORATORS } from '@nestjs/swagger';
import { SearchController } from './search.controller';
import { SearchService } from './search.service';
import { SearchQueryDto } from './dto/search-query.dto';
@@ -62,4 +63,15 @@ describe('SearchController', () => {
search.mockRejectedValue(new NotImplementedException('none'));
await expect(ctrl.search({ q: 'x' }, undefined)).rejects.toBeInstanceOf(NotImplementedException);
});
+
+ it('publishes limit and offset as integer query parameters', () => {
+ // eslint-disable-next-line @typescript-eslint/unbound-method -- reading route metadata, not invoking
+ const params = Reflect.getMetadata(DECORATORS.API_PARAMETERS, SearchController.prototype.search) as Array<{
+ name: string;
+ type?: unknown;
+ }>;
+ const typeOf = (name: string) => params.find(p => p.name === name)?.type;
+ expect(typeOf('limit')).toBe('integer');
+ expect(typeOf('offset')).toBe('integer');
+ });
});
diff --git a/src/modules/search/search.controller.ts b/src/modules/search/search.controller.ts
index 31b2ec236..4575e71cd 100644
--- a/src/modules/search/search.controller.ts
+++ b/src/modules/search/search.controller.ts
@@ -39,11 +39,11 @@ export class SearchController {
@ApiQuery({ name: 'from', required: false, description: 'Sender filter' })
@ApiQuery({ name: 'dateFrom', required: false, description: 'Epoch-ms lower bound (inclusive)' })
@ApiQuery({ name: 'dateTo', required: false, description: 'Epoch-ms upper bound (inclusive)' })
- @ApiQuery({ name: 'limit', required: false, type: Number, description: 'Max hits to return' })
+ @ApiQuery({ name: 'limit', required: false, type: 'integer', description: 'Max hits to return' })
@ApiQuery({
name: 'offset',
required: false,
- type: Number,
+ type: 'integer',
description: `Pagination offset, at most ${SEARCH_OFFSET_MAX}`,
})
async search(@Query() dto: SearchQueryDto, @CurrentApiKey() apiKey?: ApiKey): Promise<SearchResults> {