updated swagger doc for 403 and 401

chingu-x · Jun 10, 2024 · 7c3ad8e · 7c3ad8e
1 parent e1cac24
commit 7c3ad8e
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/src/teams/teams.controller.ts b/src/teams/teams.controller.ts
@@ -17,6 +17,7 @@ import {
     VoyageTeamResponse,
 } from "./teams.response";
 import {
+    ForbiddenErrorResponse,
     NotFoundErrorResponse,
     UnauthorizedErrorResponse,
 } from "../global/responses/errors";
@@ -39,6 +40,16 @@ export class TeamsController {
         type: VoyageTeamResponse,
         isArray: true,
     })
+    @ApiResponse({
+        status: HttpStatus.UNAUTHORIZED,
+        description: "unauthorized access - user is not logged in",
+        type: UnauthorizedErrorResponse,
+    })
+    @ApiResponse({
+        status: HttpStatus.FORBIDDEN,
+        description: "forbidden - user does not have the required permission",
+        type: ForbiddenErrorResponse,
+    })
     @CheckAbilities({ action: Action.Manage, subject: "all" })
     @Get()
     findAll() {
@@ -69,6 +80,16 @@ export class TeamsController {
         required: true,
         example: 1,
     })
+    @ApiResponse({
+        status: HttpStatus.UNAUTHORIZED,
+        description: "unauthorized access - user is not logged in",
+        type: UnauthorizedErrorResponse,
+    })
+    @ApiResponse({
+        status: HttpStatus.FORBIDDEN,
+        description: "forbidden - user does not have the required permission",
+        type: ForbiddenErrorResponse,
+    })
     @CheckAbilities({ action: Action.Manage, subject: "all" })
     @Get("voyages/:voyageId")
     findTeamsByVoyageId(@Param("voyageId", ParseIntPipe) voyageId: number) {