From 977cc6fb070027e121ee5a8313d6caf61bc30f98 Mon Sep 17 00:00:00 2001
From: faris Aljohari <83524184+farisaljohari@users.noreply.github.com>
Date: Sat, 23 Nov 2024 22:51:30 -0600
Subject: [PATCH] Add API operation descriptions to user device permission
 controller

---
 .../user-device-permission.controller.ts      | 27 +++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/src/user-device-permission/controllers/user-device-permission.controller.ts b/src/user-device-permission/controllers/user-device-permission.controller.ts
index 5ff5284..7d33b7f 100644
--- a/src/user-device-permission/controllers/user-device-permission.controller.ts
+++ b/src/user-device-permission/controllers/user-device-permission.controller.ts
@@ -9,17 +9,18 @@ import {
   Put,
   UseGuards,
 } from '@nestjs/common';
-import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
+import { ApiBearerAuth, ApiTags, ApiOperation } from '@nestjs/swagger';
 import { UserDevicePermissionService } from '../services/user-device-permission.service';
 import { UserDevicePermissionAddDto } from '../dtos/user-device-permission.add.dto';
 import { UserDevicePermissionEditDto } from '../dtos/user-device-permission.edit.dto';
 import { AdminRoleGuard } from 'src/guards/admin.role.guard';
 import { EnableDisableStatusEnum } from '@app/common/constants/days.enum';
+import { ControllerRoute } from '@app/common/constants/controller-route';
 
 @ApiTags('Device Permission Module')
 @Controller({
   version: EnableDisableStatusEnum.ENABLED,
-  path: 'device-permission',
+  path: ControllerRoute.DEVICE_PERMISSION.ROUTE,
 })
 export class UserDevicePermissionController {
   constructor(
@@ -29,6 +30,11 @@ export class UserDevicePermissionController {
   @ApiBearerAuth()
   @UseGuards(AdminRoleGuard)
   @Post()
+  @ApiOperation({
+    summary: ControllerRoute.DEVICE_PERMISSION.ACTIONS.ADD_PERMISSION_SUMMARY,
+    description:
+      ControllerRoute.DEVICE_PERMISSION.ACTIONS.ADD_PERMISSION_DESCRIPTION,
+  })
   async addDevicePermission(
     @Body() userDevicePermissionDto: UserDevicePermissionAddDto,
   ) {
@@ -45,6 +51,11 @@ export class UserDevicePermissionController {
   @ApiBearerAuth()
   @UseGuards(AdminRoleGuard)
   @Put(':devicePermissionUuid')
+  @ApiOperation({
+    summary: ControllerRoute.DEVICE_PERMISSION.ACTIONS.EDIT_PERMISSION_SUMMARY,
+    description:
+      ControllerRoute.DEVICE_PERMISSION.ACTIONS.EDIT_PERMISSION_DESCRIPTION,
+  })
   async editDevicePermission(
     @Param('devicePermissionUuid') devicePermissionUuid: string,
     @Body() userDevicePermissionEditDto: UserDevicePermissionEditDto,
@@ -62,6 +73,11 @@ export class UserDevicePermissionController {
   @ApiBearerAuth()
   @UseGuards(AdminRoleGuard)
   @Get(':deviceUuid')
+  @ApiOperation({
+    summary: ControllerRoute.DEVICE_PERMISSION.ACTIONS.FETCH_PERMISSION_SUMMARY,
+    description:
+      ControllerRoute.DEVICE_PERMISSION.ACTIONS.FETCH_PERMISSION_DESCRIPTION,
+  })
   async fetchDevicePermission(@Param('deviceUuid') deviceUuid: string) {
     const deviceDetails =
       await this.userDevicePermissionService.fetchUserPermission(deviceUuid);
@@ -71,9 +87,16 @@ export class UserDevicePermissionController {
       data: deviceDetails,
     };
   }
+
   @ApiBearerAuth()
   @UseGuards(AdminRoleGuard)
   @Delete(':devicePermissionUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.DEVICE_PERMISSION.ACTIONS.DELETE_PERMISSION_SUMMARY,
+    description:
+      ControllerRoute.DEVICE_PERMISSION.ACTIONS.DELETE_PERMISSION_DESCRIPTION,
+  })
   async deleteDevicePermission(
     @Param('devicePermissionUuid') devicePermissionUuid: string,
   ) {