From c1b8e63c5e74fd8f95235a2937704745fb9007bd Mon Sep 17 00:00:00 2001
From: faris Aljohari <83524184+farisaljohari@users.noreply.github.com>
Date: Sat, 23 Nov 2024 22:50:13 -0600
Subject: [PATCH] Add `ApiOperation` decorators to AutomationController
 endpoints

---
 .../controllers/automation.controller.ts      | 35 +++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/src/automation/controllers/automation.controller.ts b/src/automation/controllers/automation.controller.ts
index 49a5012..8d9d1ab 100644
--- a/src/automation/controllers/automation.controller.ts
+++ b/src/automation/controllers/automation.controller.ts
@@ -10,7 +10,7 @@ import {
   Put,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags, ApiBearerAuth } from '@nestjs/swagger';
+import { ApiTags, ApiBearerAuth, ApiOperation } from '@nestjs/swagger';
 import {
   AddAutomationDto,
   UpdateAutomationDto,
@@ -19,11 +19,12 @@ import {
 import { JwtAuthGuard } from '@app/common/guards/jwt.auth.guard';
 import { EnableDisableStatusEnum } from '@app/common/constants/days.enum';
 import { AutomationParamDto, SpaceParamDto } from '../dtos';
+import { ControllerRoute } from '@app/common/constants/controller-route';
 
 @ApiTags('Automation Module')
 @Controller({
   version: EnableDisableStatusEnum.ENABLED,
-  path: 'automation',
+  path: ControllerRoute.AUTOMATION.ROUTE,
 })
 export class AutomationController {
   constructor(private readonly automationService: AutomationService) {}
@@ -31,6 +32,10 @@ export class AutomationController {
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Post()
+  @ApiOperation({
+    summary: ControllerRoute.AUTOMATION.ACTIONS.ADD_AUTOMATION_SUMMARY,
+    description: ControllerRoute.AUTOMATION.ACTIONS.ADD_AUTOMATION_DESCRIPTION,
+  })
   async addAutomation(@Body() addAutomationDto: AddAutomationDto) {
     const automation =
       await this.automationService.addAutomation(addAutomationDto);
@@ -45,6 +50,11 @@ export class AutomationController {
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Get(':spaceUuid')
+  @ApiOperation({
+    summary: ControllerRoute.AUTOMATION.ACTIONS.GET_AUTOMATION_BY_SPACE_SUMMARY,
+    description:
+      ControllerRoute.AUTOMATION.ACTIONS.GET_AUTOMATION_BY_SPACE_DESCRIPTION,
+  })
   async getAutomationBySpace(@Param() param: SpaceParamDto) {
     const automation = await this.automationService.getAutomationBySpace(
       param.spaceUuid,
@@ -55,6 +65,11 @@ export class AutomationController {
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Get('details/:automationUuid')
+  @ApiOperation({
+    summary: ControllerRoute.AUTOMATION.ACTIONS.GET_AUTOMATION_DETAILS_SUMMARY,
+    description:
+      ControllerRoute.AUTOMATION.ACTIONS.GET_AUTOMATION_DETAILS_DESCRIPTION,
+  })
   async getAutomationDetails(@Param() param: AutomationParamDto) {
     const automation = await this.automationService.getAutomationDetails(
       param.automationUuid,
@@ -65,6 +80,11 @@ export class AutomationController {
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Delete(':automationUuid')
+  @ApiOperation({
+    summary: ControllerRoute.AUTOMATION.ACTIONS.DELETE_AUTOMATION_SUMMARY,
+    description:
+      ControllerRoute.AUTOMATION.ACTIONS.DELETE_AUTOMATION_DESCRIPTION,
+  })
   async deleteAutomation(@Param() param: AutomationParamDto) {
     await this.automationService.deleteAutomation(param);
     return {
@@ -76,6 +96,11 @@ export class AutomationController {
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Put(':automationUuid')
+  @ApiOperation({
+    summary: ControllerRoute.AUTOMATION.ACTIONS.UPDATE_AUTOMATION_SUMMARY,
+    description:
+      ControllerRoute.AUTOMATION.ACTIONS.UPDATE_AUTOMATION_DESCRIPTION,
+  })
   async updateAutomation(
     @Body() updateAutomationDto: UpdateAutomationDto,
     @Param() param: AutomationParamDto,
@@ -95,6 +120,12 @@ export class AutomationController {
   @ApiBearerAuth()
   @UseGuards(JwtAuthGuard)
   @Put('status/:automationUuid')
+  @ApiOperation({
+    summary:
+      ControllerRoute.AUTOMATION.ACTIONS.UPDATE_AUTOMATION_STATUS_SUMMARY,
+    description:
+      ControllerRoute.AUTOMATION.ACTIONS.UPDATE_AUTOMATION_STATUS_DESCRIPTION,
+  })
   async updateAutomationStatus(
     @Body() updateAutomationStatusDto: UpdateAutomationStatusDto,
     @Param() param: AutomationParamDto,