docs : 토론글 관련 swagger 업데이트

Author: NCookies

src/main/java/org/ezcode/codetest/application/community/dto/response/DiscussionResponse.java

@@ -11,7 +11,7 @@
 
 import io.swagger.v3.oas.annotations.media.Schema;
 
-@Schema(name = "DiscussionResponse", description = "Discussion 조회 응답 DTO")
+@Schema(name = "DiscussionResponse", description = "Discussion 응답 DTO, 목록 조회 시에만 추천 수, 비추천 수 등의 데이터가 포함됨")
 public record DiscussionResponse(
 
 	@Schema(description = "Discussion 고유 ID", example = "123", requiredMode = REQUIRED)
@@ -26,14 +26,19 @@ public record DiscussionResponse(
 	@Schema(description = "토론 내용", example = "이 문제는 이렇게 풀 수 있습니다...", requiredMode = REQUIRED)
 	String content,
 
+	@Schema(description = "생성 일시", example = "2025-06-25T14:30:00", requiredMode = REQUIRED)
 	LocalDateTime createdAt,
 
+	@Schema(description = "총 추천 수 (upvote)", example = "10")
 	Long upvoteCount,
 
+	@Schema(description = "총 비추천 수 (downvote)", example = "2")
 	Long downvoteCount,
 
+	@Schema(description = "총 댓글 수", example = "5")
 	Long replyCount,
 
+	@Schema(description = "현재 사용자의 추천 상태 (UP, DOWN, NONE)", example = "UP")
 	VoteType voteStatus
 
 ) {

src/main/java/org/ezcode/codetest/presentation/community/DiscussionController.java

@@ -21,16 +21,29 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 
 @RestController
 @RequestMapping("/api/problems/{problemId}/discussions")
+@Tag(name = "Discussions", description = "문제별 토론글 관리 API")
 @RequiredArgsConstructor
 public class DiscussionController {
 
 	private final DiscussionService discussionService;
 
+	@Operation(
+		summary = "토론 생성",
+		description = "주어진 문제 ID에 새로운 Discussion을 생성합니다.",
+		parameters = {
+			@Parameter(name = "problemId", description = "문제 ID", required = true)
+		}
+	)
+	@ApiResponse(responseCode = "201", description = "생성된 DiscussionResponse 반환")
 	@PostMapping
 	public ResponseEntity<DiscussionResponse> createDiscussion(
 		@PathVariable Long problemId,
@@ -42,6 +55,15 @@ public ResponseEntity<DiscussionResponse> createDiscussion(
 			.body(discussionService.createDiscussion(problemId, request, authUser.getId()));
 	}
 
+	@Operation(
+		summary = "토론 목록 조회",
+		description = "문제별 Discussion 목록을 정렬(sortBy) 및 페이징(pageable)하여 조회합니다. 로그인하지 않은 상태로도 조회할 수 있습니다.",
+		parameters = {
+			@Parameter(name = "problemId", description = "문제 ID", required = true),
+			@Parameter(name = "sortBy", description = "정렬 기준 (best, upvote, latest), best: upvote-downvote 순으로 정렬", example = "best", required = false)
+		}
+	)
+	@ApiResponse(responseCode = "200", description = "토론 목록 조회 성공")
 	@GetMapping
 	public ResponseEntity<Page<DiscussionResponse>> getDiscussions(
 		@PathVariable Long problemId,
@@ -57,6 +79,15 @@ public ResponseEntity<Page<DiscussionResponse>> getDiscussions(
 			.body(discussionService.getDiscussions(problemId, sortBy, currentUserId, pageable));
 	}
 
+	@Operation(
+		summary = "토론 수정",
+		description = "특정 Discussion을 수정합니다.",
+		parameters = {
+			@Parameter(name = "problemId", description = "문제 ID", required = true),
+			@Parameter(name = "discussionId", description = "토론 ID", required = true)
+		}
+	)
+	@ApiResponse(responseCode = "200", description = "수정된 DiscussionResponse 반환")
 	@PutMapping("/{discussionId}")
 	public ResponseEntity<DiscussionResponse> modifyDiscussion(
 		@PathVariable Long problemId,
@@ -69,6 +100,15 @@ public ResponseEntity<DiscussionResponse> modifyDiscussion(
 			.body(discussionService.modifyDiscussion(problemId, discussionId, request, authUser.getId()));
 	}
 
+	@Operation(
+		summary = "토론 삭제",
+		description = "특정 Discussion을 삭제합니다.",
+		parameters = {
+			@Parameter(name = "problemId", description = "문제 ID", required = true),
+			@Parameter(name = "discussionId", description = "토론 ID", required = true)
+		}
+	)
+	@ApiResponse(responseCode = "200", description = "삭제 성공")
 	@DeleteMapping("/{discussionId}")
 	public ResponseEntity<Void> removeDiscussion(
 		@PathVariable Long problemId,