From 04b1c003402dd5507c160657f73c4d6b3457fe0a Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Tue, 7 Apr 2026 22:50:31 +0530 Subject: [PATCH] fix: mark v1 in-app api as deprecated --- .../subscribers/subscribersV1.controller.ts | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/apps/api/src/app/subscribers/subscribersV1.controller.ts b/apps/api/src/app/subscribers/subscribersV1.controller.ts index 34c4a63166d..d1846a65c2d 100644 --- a/apps/api/src/app/subscribers/subscribersV1.controller.ts +++ b/apps/api/src/app/subscribers/subscribersV1.controller.ts @@ -584,7 +584,8 @@ export class SubscribersV1Controller { @Get('/:subscriberId/notifications/feed') @ApiOperation({ summary: 'Retrieve subscriber notifications', - description: `Retrieve subscriber in-app (inbox) notifications by its unique key identifier **subscriberId**.`, + description: `This API is deprecated, use v2 API instead. Retrieve subscriber in-app notifications by its unique key identifier **subscriberId**.`, + deprecated: true, }) @ApiResponse(FeedResponseDto) @SdkGroupName('Subscribers.Notifications') @@ -619,7 +620,8 @@ export class SubscribersV1Controller { @ApiResponse(UnseenCountResponse) @ApiOperation({ summary: 'Retrieve unseen notifications count', - description: `Retrieve unseen in-app (inbox) notifications count for a subscriber by its unique key identifier **subscriberId**.`, + description: `This API is deprecated, use v2 API instead. Retrieve unseen in-app notifications count for a subscriber by its unique key identifier **subscriberId**.`, + deprecated: true, }) @SdkGroupName('Subscribers.Notifications') @SdkMethodName('unseenCount') @@ -656,7 +658,7 @@ export class SubscribersV1Controller { @Post('/:subscriberId/messages/markAs') @ApiOperation({ summary: 'Mark a subscriber feed messages as seen or as read', - description: `Introducing '/:subscriberId/messages/mark-as endpoint for consistent read and seen message handling, + description: `This API is deprecated, use v2 API instead. Introducing '/:subscriberId/messages/mark-as endpoint for consistent read and seen message handling, deprecating old legacy endpoint.`, deprecated: true, }) @@ -686,8 +688,9 @@ export class SubscribersV1Controller { @ApiOperation({ summary: 'Update notifications state', - description: `Update subscriber's multiple in-app (inbox) notifications state such as seen, read, unseen or unread by **subscriberId**. - **messageId** is of type mongodbId of notifications`, + description: `This API is deprecated, use v2 API instead. Update subscriber's multiple in-app notifications state such as seen, read, unseen or unread by **subscriberId**. + **messageId** is of type mongodbId of notifications. This API is deprecated, use v2 API instead.`, + deprecated: true, }) @ExternalApiAccessible() @RequireAuthentication() @@ -720,7 +723,8 @@ export class SubscribersV1Controller { @Post('/:subscriberId/messages/mark-all') @ApiOperation({ summary: 'Update all notifications state', - description: `Update all subscriber in-app (inbox) notifications state such as read, unread, seen or unseen by **subscriberId**.`, + description: `This API is deprecated, use v2 API instead. Update all subscriber in-app notifications state such as read, unread, seen or unseen by **subscriberId**.`, + deprecated: true, }) @ApiCreatedResponse({ type: Number, @@ -750,8 +754,9 @@ export class SubscribersV1Controller { @Post('/:subscriberId/messages/:messageId/actions/:type') @ApiOperation({ summary: 'Update notification action status', - description: `Update in-app (inbox) notification's action status by its unique key identifier **messageId** and type field **type**. + description: `This API is deprecated, use v2 API instead. Update in-app notification's action status by its unique key identifier **messageId** and type field **type**. **type** field can be **primary** or **secondary**`, + deprecated: true, }) @ApiResponse(MessageResponseDto, 201) @SdkGroupName('Subscribers.Messages')