Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): declare 400 on chat history and reaction reads

Yudhi Armyndharis359fbe3b9f38
diff --git a/src/modules/message/message.controller.spec.ts b/src/modules/message/message.controller.spec.ts
index 3df4755ba..ce85f336f 100644
--- a/src/modules/message/message.controller.spec.ts
+++ b/src/modules/message/message.controller.spec.ts
@@ -210,3 +210,15 @@ describe('MessageController - caller-supplied batch ids', () => {
expect(res.statusUrl).toBe('/api/sessions/s1/messages/batch/run%2F1%3Fx');
});
});
+
+// MessageService.getEngine() answers 400 for a session with no live engine; clients generated from
+// the OpenAPI contract need it declared on the read routes too.
+describe('MessageController OpenAPI error responses', () => {
+ it.each(['getChatHistory', 'getReactions'])('%s declares 400', method => {
+ const responses = Reflect.getMetadata(
+ 'swagger/apiResponse',
+ Object.getOwnPropertyDescriptor(MessageController.prototype, method)!.value as object,
+ ) as Record<string, unknown>;
+ expect(Object.keys(responses)).toContain('400');
+ });
+});
diff --git a/src/modules/message/message.controller.ts b/src/modules/message/message.controller.ts
index f50856b45..a4a2f6782 100644
--- a/src/modules/message/message.controller.ts
+++ b/src/modules/message/message.controller.ts
@@ -592,6 +592,7 @@ export class MessageController {
description: 'Chat history (most recent messages, oldest first)',
type: [ChatHistoryMessageDto],
})
+ @ApiResponse({ status: 400, description: 'Session not active' })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@ApiResponse({ status: 501, description: ENGINE_NOT_SUPPORTED_501 })
@ApiResponse({
@@ -637,6 +638,7 @@ export class MessageController {
description: 'List of reactions with senders',
type: [MessageReactionDto],
})
+ @ApiResponse({ status: 400, description: 'Session not active' })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@ApiResponse({ status: 404, description: MESSAGE_NOT_FOUND_404 })
@ApiResponse({ status: 501, description: ENGINE_NOT_SUPPORTED_501 })