refactor: document api endpoints

packages/server-nest/src/modules/Branches/Branches.controller.ts

@@ -10,7 +10,7 @@ import {
 import { BranchesApplication } from './BranchesApplication.service';
 import { ICreateBranchDTO, IEditBranchDTO } from './Branches.types';
 import { PublicRoute } from '../Auth/Jwt.guard';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 
 @Controller('branches')
 @ApiTags('branches')
@@ -20,42 +20,75 @@ export class BranchesController {
 
   @Get()
   @ApiOperation({ summary: 'Retrieves the branches.' })
+  @ApiResponse({
+    status: 200,
+    description: 'The branches have been successfully retrieved.',
+  })
   getBranches() {
     return this.branchesApplication.getBranches();
   }
 
   @Get(':id')
   @ApiOperation({ summary: 'Retrieves the branch details.' })
+  @ApiResponse({
+    status: 200,
+    description: 'The branch details have been successfully retrieved.',
+  })
+  @ApiResponse({ status: 404, description: 'The branch not found.' })
   getBranch(@Param('id') id: string) {
     return this.branchesApplication.getBranch(Number(id));
   }
 
   @Post()
   @ApiOperation({ summary: 'Create a new branch.' })
+  @ApiResponse({
+    status: 200,
+    description: 'The branch has been successfully created.',
+  })
+  @ApiResponse({ status: 404, description: 'The branch not found.' })
   createBranch(@Body() createBranchDTO: ICreateBranchDTO) {
     return this.branchesApplication.createBranch(createBranchDTO);
   }
 
   @Put(':id')
   @ApiOperation({ summary: 'Edit the given branch.' })
+  @ApiResponse({
+    status: 200,
+    description: 'The branch has been successfully edited.',
+  })
+  @ApiResponse({ status: 404, description: 'The branch not found.' })
   editBranch(@Param('id') id: string, @Body() editBranchDTO: IEditBranchDTO) {
     return this.branchesApplication.editBranch(Number(id), editBranchDTO);
   }
 
   @Delete(':id')
   @ApiOperation({ summary: 'Delete the given branch.' })
+  @ApiResponse({
+    status: 200,
+    description: 'The branch has been successfully deleted.',
+  })
+  @ApiResponse({ status: 404, description: 'The branch not found.' })
   deleteBranch(@Param('id') id: string) {
     return this.branchesApplication.deleteBranch(Number(id));
   }
 
   @Post('activate')
   @ApiOperation({ summary: 'Activate the branches feature.' })
+  @ApiResponse({
+    status: 200,
+    description: 'The branches feature has been successfully activated.',
+  })
   activateBranches() {
     return this.branchesApplication.activateBranches();
   }
 
   @Put(':id/mark-as-primary')
   @ApiOperation({ summary: 'Mark the given branch as primary.' })
+  @ApiResponse({
+    status: 200,
+    description: 'The branch has been successfully marked as primary.',
+  })
+  @ApiResponse({ status: 404, description: 'The branch not found.' })
   markBranchAsPrimary(@Param('id') id: string) {
     return this.branchesApplication.markBranchAsPrimary(Number(id));
   }