Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(status): correct the status list, media and caption descriptions

Yudhi Armyndharis7a12aee3a8f7
diff --git a/src/modules/status/dto/status-response.dto.ts b/src/modules/status/dto/status-response.dto.ts
index e29df9bf3..bbd1876fa 100644
--- a/src/modules/status/dto/status-response.dto.ts
+++ b/src/modules/status/dto/status-response.dto.ts
@@ -34,7 +34,7 @@ export class StatusDto {
})
type!: string;
- @ApiPropertyOptional({ description: 'Caption, for an image or video status.' })
+ @ApiPropertyOptional({ description: 'Text of a text status, or the caption of an image or video status.' })
caption?: string;
@ApiPropertyOptional({
diff --git a/src/modules/status/status.controller.ts b/src/modules/status/status.controller.ts
index d8f0049c7..0f8e40031 100644
--- a/src/modules/status/status.controller.ts
+++ b/src/modules/status/status.controller.ts
@@ -23,7 +23,7 @@ export class StatusController {
@ApiOperation({ summary: 'Get all contact status updates' })
@ApiResponse({
status: 200,
- description: 'Status updates visible to the session, grouped by contact.',
+ description: 'Status updates visible to the session, newest first.',
type: StatusListResponseDto,
})
async getStatuses(@Param('sessionId') sessionId: string) {
@@ -47,7 +47,7 @@ export class StatusController {
@ApiOperation({ summary: 'Stream a stored status media file' })
@ApiResponse({
status: 200,
- description: 'The status image/video bytes.',
+ description: 'The status image, video or voice note (audio) bytes.',
content: { 'application/octet-stream': { schema: { type: 'string', format: 'binary' } } },
})
@ApiResponse({ status: 404, description: 'No stored media (text status, omitted, or expired).' })