Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(session): declare the presence read's null body in OpenAPI

Yudhi Armyndharise081ed4d3e21
diff --git a/src/modules/session/session.controller.spec.ts b/src/modules/session/session.controller.spec.ts
index 36d931ef6..1f4585f8f 100644
--- a/src/modules/session/session.controller.spec.ts
+++ b/src/modules/session/session.controller.spec.ts
@@ -606,3 +606,15 @@ describe('SessionController OpenAPI error responses', () => {
expect(Object.keys(responses)).toContain(status);
});
});
+
+// getPresence answers a normal 200 with a JSON null body when nothing was reported, so the published
+// schema must admit null or a generated client rejects that answer.
+describe('SessionController.getPresence() OpenAPI response', () => {
+ it('declares the 200 body nullable', () => {
+ const responses = Reflect.getMetadata(
+ 'swagger/apiResponse',
+ Object.getOwnPropertyDescriptor(SessionControllerClass.prototype, 'getPresence')!.value as object,
+ ) as Record<string, { schema?: { nullable?: boolean } }>;
+ expect(responses['200'].schema?.nullable).toBe(true);
+ });
+});
diff --git a/src/modules/session/session.controller.ts b/src/modules/session/session.controller.ts
index d7004601f..88579c0d2 100644
--- a/src/modules/session/session.controller.ts
+++ b/src/modules/session/session.controller.ts
@@ -16,7 +16,7 @@ import {
Res,
} from '@nestjs/common';
import type { Response } from 'express';
-import { ApiTags, ApiOperation, ApiResponse, ApiParam, ApiQuery } from '@nestjs/swagger';
+import { ApiTags, ApiOperation, ApiResponse, ApiParam, ApiQuery, ApiExtraModels, getSchemaPath } from '@nestjs/swagger';
import { SessionService } from './session.service';
import {
CreateSessionDto,
@@ -680,7 +680,12 @@ export class SessionController {
})
@ApiParam({ name: 'sessionId', description: 'Session ID' })
@ApiParam({ name: 'chatId', description: 'Chat ID as subscribed' })
- @ApiResponse({ status: 200, description: 'Last reported presence, or null', type: ChatPresenceResponseDto })
+ @ApiExtraModels(ChatPresenceResponseDto)
+ @ApiResponse({
+ status: 200,
+ description: 'Last reported presence, or null',
+ schema: { nullable: true, allOf: [{ $ref: getSchemaPath(ChatPresenceResponseDto) }] },
+ })
@ApiResponse({ status: 404, description: 'Session not found' })
async getPresence(
@Param('sessionId', ParseUUIDPipe) id: string,