Add API operation descriptions to DoorLockController

src/door-lock/controllers/door.lock.controller.ts

@@ -10,23 +10,31 @@ import {
   UseGuards,
   Put,
 } from '@nestjs/common';
-import { ApiTags, ApiBearerAuth } from '@nestjs/swagger';
+import { ApiTags, ApiBearerAuth, ApiOperation } from '@nestjs/swagger';
 import { AddDoorLockOnlineDto } from '../dtos/add.online-temp.dto';
 import { AddDoorLockOfflineTempMultipleTimeDto } from '../dtos/add.offline-temp.dto';
 import { JwtAuthGuard } from '@app/common/guards/jwt.auth.guard';
 import { UpdateDoorLockOfflineTempDto } from '../dtos/update.offline-temp.dto';
 import { EnableDisableStatusEnum } from '@app/common/constants/days.enum';
+import { ControllerRoute } from '@app/common/constants/controller-route';
 
 @ApiTags('Door Lock Module')
 @Controller({
   version: EnableDisableStatusEnum.ENABLED,
-  path: 'door-lock',
+  path: ControllerRoute.DOOR_LOCK.ROUTE,
 })
 export class DoorLockController {
   constructor(private readonly doorLockService: DoorLockService) {}
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Post('temporary-password/online/:doorLockUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS.ADD_ONLINE_TEMPORARY_PASSWORD_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .ADD_ONLINE_TEMPORARY_PASSWORD_DESCRIPTION,
+  })
   async addOnlineTemporaryPassword(
     @Body() addDoorLockDto: AddDoorLockOnlineDto,
     @Param('doorLockUuid') doorLockUuid: string,
@@ -40,15 +48,24 @@ export class DoorLockController {
     return {
       statusCode: HttpStatus.CREATED,
       success: true,
-      message: 'online temporary password added successfully',
+      message: 'Online temporary password added successfully',
       data: {
         id: temporaryPassword.id,
       },
     };
   }
+
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Post('temporary-password/offline/one-time/:doorLockUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .ADD_OFFLINE_ONE_TIME_TEMPORARY_PASSWORD_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .ADD_OFFLINE_ONE_TIME_TEMPORARY_PASSWORD_DESCRIPTION,
+  })
   async addOfflineOneTimeTemporaryPassword(
     @Param('doorLockUuid') doorLockUuid: string,
   ) {
@@ -60,13 +77,22 @@ export class DoorLockController {
     return {
       statusCode: HttpStatus.CREATED,
       success: true,
-      message: 'offline temporary password added successfully',
+      message: 'Offline one-time temporary password added successfully',
       data: temporaryPassword,
     };
   }
+
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Post('temporary-password/offline/multiple-time/:doorLockUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .ADD_OFFLINE_MULTIPLE_TIME_TEMPORARY_PASSWORD_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .ADD_OFFLINE_MULTIPLE_TIME_TEMPORARY_PASSWORD_DESCRIPTION,
+  })
   async addOfflineMultipleTimeTemporaryPassword(
     @Body()
     addDoorLockOfflineTempMultipleTimeDto: AddDoorLockOfflineTempMultipleTimeDto,
@@ -81,13 +107,21 @@ export class DoorLockController {
     return {
       statusCode: HttpStatus.CREATED,
       success: true,
-      message: 'offline temporary password added successfully',
+      message: 'Offline multiple-time temporary password added successfully',
       data: temporaryPassword,
     };
   }
+
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Get('temporary-password/online/:doorLockUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS.GET_ONLINE_TEMPORARY_PASSWORDS_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .GET_ONLINE_TEMPORARY_PASSWORDS_DESCRIPTION,
+  })
   async getOnlineTemporaryPasswords(
     @Param('doorLockUuid') doorLockUuid: string,
   ) {
@@ -95,9 +129,18 @@ export class DoorLockController {
       doorLockUuid,
     );
   }
+
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Delete('temporary-password/online/:doorLockUuid/:passwordId')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .DELETE_ONLINE_TEMPORARY_PASSWORD_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .DELETE_ONLINE_TEMPORARY_PASSWORD_DESCRIPTION,
+  })
   async deleteDoorLockPassword(
     @Param('doorLockUuid') doorLockUuid: string,
     @Param('passwordId') passwordId: string,
@@ -105,12 +148,21 @@ export class DoorLockController {
     await this.doorLockService.deleteDoorLockPassword(doorLockUuid, passwordId);
     return {
       statusCode: HttpStatus.OK,
-      message: 'Temporary Password deleted Successfully',
+      message: 'Temporary password deleted successfully',
     };
   }
+
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Get('temporary-password/offline/one-time/:doorLockUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .GET_OFFLINE_ONE_TIME_TEMPORARY_PASSWORDS_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .GET_OFFLINE_ONE_TIME_TEMPORARY_PASSWORDS_DESCRIPTION,
+  })
   async getOfflineOneTimeTemporaryPasswords(
     @Param('doorLockUuid') doorLockUuid: string,
   ) {
@@ -118,9 +170,18 @@ export class DoorLockController {
       doorLockUuid,
     );
   }
+
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Get('temporary-password/offline/multiple-time/:doorLockUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .GET_OFFLINE_MULTIPLE_TIME_TEMPORARY_PASSWORDS_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .GET_OFFLINE_MULTIPLE_TIME_TEMPORARY_PASSWORDS_DESCRIPTION,
+  })
   async getOfflineMultipleTimeTemporaryPasswords(
     @Param('doorLockUuid') doorLockUuid: string,
   ) {
@@ -132,9 +193,16 @@ export class DoorLockController {
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Put('temporary-password/:doorLockUuid/offline/:passwordId')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .UPDATE_OFFLINE_TEMPORARY_PASSWORD_SUMMARY,
+    description:
+      ControllerRoute.DOOR_LOCK.ACTIONS
+        .UPDATE_OFFLINE_TEMPORARY_PASSWORD_DESCRIPTION,
+  })
   async updateOfflineTemporaryPassword(
-    @Body()
-    updateDoorLockOfflineTempDto: UpdateDoorLockOfflineTempDto,
+    @Body() updateDoorLockOfflineTempDto: UpdateDoorLockOfflineTempDto,
     @Param('doorLockUuid') doorLockUuid: string,
     @Param('passwordId') passwordId: string,
   ) {
@@ -148,20 +216,25 @@ export class DoorLockController {
     return {
       statusCode: HttpStatus.CREATED,
       success: true,
-      message: 'offline temporary password updated successfully',
+      message: 'Offline temporary password updated successfully',
       data: temporaryPassword,
     };
   }
+
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Post('open/:doorLockUuid')
+  @ApiOperation({
+    summary: ControllerRoute.DOOR_LOCK.ACTIONS.OPEN_DOOR_LOCK_SUMMARY,
+    description: ControllerRoute.DOOR_LOCK.ACTIONS.OPEN_DOOR_LOCK_DESCRIPTION,
+  })
   async openDoorLock(@Param('doorLockUuid') doorLockUuid: string) {
     await this.doorLockService.openDoorLock(doorLockUuid);
 
     return {
       statusCode: HttpStatus.CREATED,
       success: true,
-      message: 'door lock opened successfully',
+      message: 'Door lock opened successfully',
     };
   }
 }