docs: swagger 문서 보완

Nexters · Jul 30, 2024 · ab738e7 · ab738e7
1 parent 150dd53
commit ab738e7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/src/main/java/com/nexters/goalpanzi/presentation/mission/MissionVerificationController.java b/src/main/java/com/nexters/goalpanzi/presentation/mission/MissionVerificationController.java
@@ -23,7 +23,7 @@ public class MissionVerificationController implements MissionVerificationControl
     @GetMapping
     public ResponseEntity<List<MissionVerificationResponse>> getTodayVerification(
             @LoginMemberId final Long memberId,
-            @PathVariable final Long missionId
+            @PathVariable(name = "missionId") final Long missionId
     ) {
         List<MissionVerificationResponse> response = missionVerificationService.getTodayVerification(new MissionVerificationCommand(memberId, missionId));
 
@@ -33,8 +33,8 @@ public ResponseEntity<List<MissionVerificationResponse>> getTodayVerification(
     @GetMapping("/me/{number}")
     public ResponseEntity<MissionVerificationResponse> getMyVerification(
             @LoginMemberId final Long memberId,
-            @PathVariable final Long missionId,
-            @PathVariable final Integer number) {
+            @PathVariable(name = "missionId") final Long missionId,
+            @PathVariable(name = "number") final Integer number) {
         MissionVerificationResponse response = missionVerificationService.getMyVerification(
                 new MyMissionVerificationCommand(memberId, missionId, number));
 
@@ -44,7 +44,7 @@ public ResponseEntity<MissionVerificationResponse> getMyVerification(
     @PostMapping("/me")
     public ResponseEntity<Void> createVerification(
             @LoginMemberId final Long memberId,
-            @PathVariable final Long missionId,
+            @PathVariable(name = "missionId") final Long missionId,
             @RequestBody @Valid final CreateMissionVerificationRequest request) {
         missionVerificationService.createVerification(request.toServiceDto(memberId, missionId));
 

diff --git a/...in/java/com/nexters/goalpanzi/presentation/mission/MissionVerificationControllerDocs.java b/...in/java/com/nexters/goalpanzi/presentation/mission/MissionVerificationControllerDocs.java
@@ -34,8 +34,8 @@ public interface MissionVerificationControllerDocs {
     @GetMapping
     ResponseEntity<List<MissionVerificationResponse>> getTodayVerification(
             @Parameter(hidden = true) @LoginMemberId final Long memberId,
-            @Schema(description = "미션 아이디", type = "integer", requiredMode = Schema.RequiredMode.REQUIRED)
-            @PathVariable final Long missionId
+            @Schema(description = "미션 아이디", type = "integer", format = "int64", requiredMode = Schema.RequiredMode.REQUIRED)
+            @PathVariable(name = "missionId") final Long missionId
     );
 
     @Operation(summary = "나의 미션 인증 현황 조회", description = "보드판에 해당하는 미션 인증 현황을 조회합니다.")
@@ -47,10 +47,10 @@ ResponseEntity<List<MissionVerificationResponse>> getTodayVerification(
     @GetMapping("/me/{number}")
     ResponseEntity<MissionVerificationResponse> getMyVerification(
             @Parameter(hidden = true) @LoginMemberId final Long memberId,
-            @Schema(description = "미션 아이디", type = "integer", requiredMode = Schema.RequiredMode.REQUIRED)
-            @PathVariable final Long missionId,
-            @Schema(description = "보드판 번호", type = "integer", requiredMode = Schema.RequiredMode.REQUIRED)
-            @PathVariable final Integer number);
+            @Schema(description = "미션 아이디", type = "integer", format = "int64", requiredMode = Schema.RequiredMode.REQUIRED)
+            @PathVariable(name = "missionId") final Long missionId,
+            @Schema(description = "보드판 번호", type = "integer", format = "int32", requiredMode = Schema.RequiredMode.REQUIRED)
+            @PathVariable(name = "number") final Integer number);
 
     @Operation(summary = "미션 인증", description = "미션 인증을 위해 이미지를 업로드합니다.")
     @ApiResponses({
@@ -62,7 +62,7 @@ ResponseEntity<MissionVerificationResponse> getMyVerification(
     @PostMapping("/me")
     ResponseEntity<Void> createVerification(
             @Parameter(hidden = true) @LoginMemberId final Long memberId,
-            @Schema(description = "미션 아이디", type = "integer")
-            @PathVariable final Long missionId,
+            @Schema(description = "미션 아이디", type = "integer", format = "int64", requiredMode = Schema.RequiredMode.REQUIRED)
+            @PathVariable(name = "missionId") final Long missionId,
             @RequestBody @Valid final CreateMissionVerificationRequest request);
-}
+}