Merge pull request #260 from boostcampwm2023/docs/be/swagger

swagger 문서 수정
boostcampwm2023 · Mar 8, 2024 · 729130e · 729130e
2 parents 0e1347d + cc376d0
commit 729130e
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 1 deletion.
diff --git a/backend/src/auth/auth.controller.ts b/backend/src/auth/auth.controller.ts
@@ -14,6 +14,7 @@ import { HttpExceptionFilter } from 'src/exceptions/http.exception.filter';
 import {
     AuthSuccess,
     ExpiredTokenError,
+    InvalidCodeError,
     InvalidTokenError,
     RefreshJWTSuccess,
     VerifyEmailSuccess,
@@ -64,6 +65,7 @@ export class AuthController {
     @ApiOperation({ summary: '이메일 인증 코드 검증', description: '이메일 인증 코드를 검증한다.' })
     @ApiOkResponse({ type: VerifyEmailSuccess, description: '이메일 인증 성공' })
     @ApiBadRequestResponse({ type: RequestError, description: '잘못된 요청입니다.' })
+    @ApiUnauthorizedResponse({ type: InvalidCodeError, description: '유효하지 않은 인증코드' })
     @ApiNotFoundResponse({ type: EmailNotFound, description: '해당 이메일로 발급받은 코드가 없거나 만료됨' })
     @ApiBody({ type: VerifyEmailDto })
     @Post('/verify/email')

diff --git a/backend/src/dto/auth.swagger.dto.ts b/backend/src/dto/auth.swagger.dto.ts
@@ -80,3 +80,16 @@ export class VerifyEmailSuccess {
     })
     verifyToken: string;
 }
+
+export class InvalidCodeError {
+    @ApiProperty({
+        example: HttpStatus.UNAUTHORIZED,
+        description: 'Http 상태 코드',
+    })
+    statusCode: number;
+    @ApiProperty({
+        example: '유효하지 않은 인증 코드.',
+        description: '메시지',
+    })
+    message: string;
+}
diff --git a/backend/src/dto/user.swagger.dto.ts b/backend/src/dto/user.swagger.dto.ts
@@ -183,6 +183,11 @@ export class CheckEmailVerificatedSuccess {
         description: 'Http 상태 코드',
     })
     statusCode: number;
+    @ApiProperty({
+        example: 'true',
+        description: '사용자 이메일 인증 여부',
+    })
+    verified: boolean;
     @ApiProperty({
         example: '사용자 이메일 인증 여부 조회 성공',
         description: '메시지',

diff --git a/backend/src/user/user.controller.ts b/backend/src/user/user.controller.ts
@@ -159,7 +159,7 @@ export class UsersController {
         name: 'Authorization Bearer Token',
         description: 'accessToken',
     })
-    @ApiOkResponse({ type: CheckEmailVerificatedSuccess, description: '이메일 인증 코드 발송 성공' })
+    @ApiOkResponse({ type: CheckEmailVerificatedSuccess, description: '사용자 이메일 인증 여부 확인 성공' })
     @ApiBadRequestResponse({ type: RequestError, description: '잘못된 요청입니다.' })
     @ApiNotFoundResponse({ type: EmailNotFound, description: '해당 이메일의 사용자를 찾을 수 없음' })
     @ApiUnauthorizedResponse({ type: UnauthorizedRequest, description: '승인되지 않은 요청' })