docs: swagger 설명 추가

Nexters · Aug 11, 2024 · f5f609c · f5f609c
1 parent 4aaf300
commit f5f609c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/src/main/java/com/nexters/goalpanzi/presentation/mission/MissionBoardControllerDocs.java b/src/main/java/com/nexters/goalpanzi/presentation/mission/MissionBoardControllerDocs.java
@@ -30,9 +30,13 @@ public interface MissionBoardControllerDocs {
             description = """
                     해당 미션의 보드판 현황을 조회합니다.
                                         
-                    보드칸에 대한 정보를 포함하며, missionBoards 배열의 크기는 보드칸의 개수만큼 입니다.
+                    보드칸에 대한 정보를 포함하며, missionBoards 배열의 크기는 **[보드칸의 개수 + 1]**만큼 입니다.
                                         
-                    0번째 보드칸은 시작점으로, 아직 미션을 시작하지 않은 상태를 나타냅니다.                    
+                    0번째 보드칸은 시작점으로, 아직 미션을 시작하지 않은 상태를 나타냅니다.
+                                        
+                    sortType 과 sortDirection 에 따라 보드칸의 장기말을 정렬합니다.
+                                        
+                    sortType, sortDirection 생략 시, **[순위순]**으로 조회합니다.
                     """)
     @ApiResponses({
             @ApiResponse(responseCode = "200"),

diff --git a/...in/java/com/nexters/goalpanzi/presentation/mission/MissionVerificationControllerDocs.java b/...in/java/com/nexters/goalpanzi/presentation/mission/MissionVerificationControllerDocs.java
@@ -36,7 +36,11 @@ public interface MissionVerificationControllerDocs {
                                         
                     0번째 항목은 나의 미션 인증 현황을 의미합니다.
                                         
-                    orderBy 에 따라 인증 현황을 정렬하며, 미션을 인증하지 않은 멤버는 프로필 정보만 포함하여 마지막에 배치됩니다.
+                    sortType 과 sortDirection 에 따라 인증 현황을 정렬합니다.
+                                        
+                    date, sortType, sortDirection 생략 시, **[오늘 기준, 인증 최신순]**으로 조회합니다.
+                                        
+                    미션을 인증하지 않은 멤버는 프로필 정보만 포함하여 마지막에 배치됩니다.
                     """
     )
     @ApiResponses({