[#132] refactor(보관함 유저 조회 API)

- API 명세 + 파라메터 swagger 추가
YAPP-19th · Jun 23, 2022 · e8445da · e8445da
1 parent 866a400
commit e8445da
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/kotlin/com/yapp/web2/domain/folder/controller/FolderController.kt b/src/main/kotlin/com/yapp/web2/domain/folder/controller/FolderController.kt
@@ -117,8 +117,10 @@ class FolderController(
         return ResponseEntity.status(HttpStatus.OK).body(folderService.encryptFolderId(folderId))
     }
 
+    @ApiOperation(value = "보관함에 속한 유저 리스트 조회 API")
     @GetMapping("belong/{folderId}")
-    fun getAccountList(@PathVariable folderId: Long): ResponseEntity<AccountDto.FolderBelongAccountListDto> {
+    fun getAccountList(@PathVariable @ApiParam(value = "폴더 ID", example = "2", required = true) folderId: Long):
+        ResponseEntity<AccountDto.FolderBelongAccountListDto> {
         return ResponseEntity.status(HttpStatus.OK).body(folderService.getAccountListAtRootFolder(folderId))
     }
 }