docs(api): add endpoint status (#54)

* docs(api): add endpoint status

* docs(api): update swagger icons

Author: AmiraKhalid04

src/decorators/api-status.decorator.ts

@@ -0,0 +1,62 @@
+import { applyDecorators } from '@nestjs/common';
+import { ApiOperation, ApiResponse } from '@nestjs/swagger';
+
+export enum ImplementationStatus {
+    IMPLEMENTED = 'implemented',
+    IN_PROGRESS = 'in-progress',
+    NOT_IMPLEMENTED = 'not-implemented',
+}
+
+interface IImplementationStatusOptions {
+    status: ImplementationStatus;
+    summary: string;
+    notes?: string;
+    expectedDate?: string;
+}
+
+/**
+ * Decorator to indicate implementation status of an endpoint in Swagger documentation
+ * Adds a small status indicator at the end of the summary
+ * @param options - Configuration object with status and summary
+ */
+export const ApiImplementationStatus = (options: IImplementationStatusOptions) => {
+    const status_config = {
+        [ImplementationStatus.IMPLEMENTED]: {
+            icon: '✅',
+            label: 'Ready',
+        },
+        [ImplementationStatus.IN_PROGRESS]: {
+            icon: '🚧',
+            label: 'In Progress',
+        },
+        [ImplementationStatus.NOT_IMPLEMENTED]: {
+            icon: '❌',
+            label: 'Not Implemented',
+        },
+    };
+
+    const config = status_config[options.status];
+
+    // Add status icon at the end of summary
+    const summary = `${options.summary} ${config.icon}`;
+
+    // Build detailed description
+    let description = `**Status:** ${config.label}`;
+
+    if (options.notes) {
+        description += `\n\n${options.notes}`;
+    }
+
+    if (options.expectedDate) {
+        description += `\n\n**Expected:** ${options.expectedDate}`;
+    }
+
+    const decorators = [
+        ApiOperation({
+            summary,
+            description,
+        }),
+    ];
+
+    return applyDecorators(...decorators);
+};

src/timeline/timeline.controller.ts

@@ -21,6 +21,7 @@ import {
 } from 'src/decorators/swagger-error-responses.decorator';
 import { timeline_swagger } from './timeline.swagger';
 import { ResponseMessage } from 'src/decorators/response-message.decorator';
+import { ApiImplementationStatus, ImplementationStatus } from 'src/decorators/api-status.decorator';
 
 @ApiBearerAuth('JWT-auth')
 @UseGuards(JwtAuthGuard)
@@ -29,6 +30,10 @@ import { ResponseMessage } from 'src/decorators/response-message.decorator';
 export class TimelineController {
     constructor(private readonly timelineService: TimelineService) {}
 
+    @ApiImplementationStatus({
+        status: ImplementationStatus.IN_PROGRESS,
+        summary: timeline_swagger.for_you.operation.summary,
+    })
     @ApiOperation(timeline_swagger.for_you.operation)
     @ApiQuery(timeline_swagger.api_query.limit)
     @ApiQuery(timeline_swagger.api_query.cursor)
@@ -44,7 +49,10 @@ export class TimelineController {
     ) {
         return await this.timelineService.getForyouTimeline(user_id, pagination);
     }
-
+    @ApiImplementationStatus({
+        status: ImplementationStatus.IMPLEMENTED,
+        summary: timeline_swagger.following.operation.summary,
+    })
     @ApiOperation(timeline_swagger.following.operation)
     @ApiQuery(timeline_swagger.api_query.limit)
     @ApiQuery(timeline_swagger.api_query.cursor)