From 59d2fcf5adc6a1738efaa60f4291d0594e9b1fc0 Mon Sep 17 00:00:00 2001
From: aniebietafia <aniebietafia87@gmail.com>
Date: Fri, 8 Nov 2024 17:51:57 +0100
Subject: [PATCH] docs: Swagger documentation for user management.

---
 .../src/users/users.controller.ts             | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/brints-estate-api/src/users/users.controller.ts b/brints-estate-api/src/users/users.controller.ts
index a3687f6..976e83c 100644
--- a/brints-estate-api/src/users/users.controller.ts
+++ b/brints-estate-api/src/users/users.controller.ts
@@ -108,6 +108,9 @@ export class UsersController {
     };
   }
 
+  @ApiOperation({
+    summary: 'Forgot password endpoint.',
+  })
   @Post('forgot-password')
   @Auth(AuthType.None)
   @HttpCode(HttpStatus.OK)
@@ -122,6 +125,9 @@ export class UsersController {
     };
   }
 
+  @ApiOperation({
+    summary: 'Resend new OTP after expiration.',
+  })
   @Post('resend-otp')
   @Auth(AuthType.None)
   @HttpCode(HttpStatus.OK)
@@ -136,6 +142,9 @@ export class UsersController {
     };
   }
 
+  @ApiOperation({
+    summary: 'Resend token to email address after expiration.',
+  })
   @Post('resend-token')
   @Auth(AuthType.None)
   @HttpCode(HttpStatus.OK)
@@ -155,6 +164,9 @@ export class UsersController {
   }
 
   @ApiBearerAuth('access-token')
+  @ApiOperation({
+    summary: 'Change user Password. User must be authenticated.',
+  })
   @Post('change-password')
   @HttpCode(HttpStatus.OK)
   @UseFilters(HttpExceptionFilter)
@@ -176,7 +188,7 @@ export class UsersController {
 
   @ApiBearerAuth('access-token')
   @ApiOperation({
-    summary: 'Get user profile.',
+    summary: 'Get user profile. User must be authenticated',
   })
   @Get('/:id')
   @Auth(AuthType.Bearer)
@@ -199,6 +211,9 @@ export class UsersController {
     };
   }
 
+  @ApiOperation({
+    summary: 'Reset forgotten password.',
+  })
   @Post('/reset-password/:email/:token')
   @Auth(AuthType.None)
   @UseInterceptors(ClassSerializerInterceptor)
@@ -221,7 +236,7 @@ export class UsersController {
 
   @ApiBearerAuth('access-token')
   @ApiOperation({
-    summary: 'Updates user details.',
+    summary: 'Update use details. User must be authenticated.',
   })
   @ApiResponse({
     status: HttpStatus.OK,