From c7a28ecb2908b36515099b96df51ea4d36c3fa3c Mon Sep 17 00:00:00 2001
From: Thuan ngo <thuanngo3072002@gmail.com>
Date: Sat, 28 Jun 2025 22:18:15 +0700
Subject: [PATCH] write doc for user api

---
 .../backend/elearning/domain/user/UserController.java  | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/main/java/com/backend/elearning/domain/user/UserController.java b/src/main/java/com/backend/elearning/domain/user/UserController.java
index 308c4d06..3f80997d 100644
--- a/src/main/java/com/backend/elearning/domain/user/UserController.java
+++ b/src/main/java/com/backend/elearning/domain/user/UserController.java
@@ -6,6 +6,7 @@
 import com.backend.elearning.domain.review.ReviewVM;
 import com.backend.elearning.exception.ErrorVm;
 import com.backend.elearning.utils.Constants;
+import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -33,11 +34,13 @@ public UserController(UserService userService, CourseService courseService) {
     }
 
     @GetMapping("/admin/users/{id}")
+    @Operation(method = "GET", summary = "Get information of user by id", description ="Send a request via API with role ADMIN to get information of user" )
     public ResponseEntity<UserGetDetailVm> getUser (@PathVariable("id") Long id) {
         return ResponseEntity.ok().body(userService.getUser(id));
     }
 
     @GetMapping("/users/{id}")
+    @Operation(method = "GET", summary = "Get information of user by id", description ="Send a request via API to get information of user" )
     public ResponseEntity<UserGetDetailVm> getUserProfile (@PathVariable("id") Long id) {
         UserGetDetailVm userProfile = userService.getUserProfile(id);
         List<CourseListGetVM> courseListGetVMS = courseService.getByUserId(id);
@@ -46,6 +49,7 @@ public ResponseEntity<UserGetDetailVm> getUserProfile (@PathVariable("id") Long
     }
 
     @GetMapping("/admin/users/paging")
+    @Operation(method = "GET", summary = "Get list information of user by pageNum, pageSize, keyword", description ="Send a request via API to get information of user" )
     public ResponseEntity<PageableData<UserVm>> getUser (
             @RequestParam(value = "pageNum", defaultValue = Constants.PageableConstant.DEFAULT_PAGE_NUMBER) int pageNum,
             @RequestParam(value = "pageSize", defaultValue = Constants.PageableConstant.DEFAULT_PAGE_SIZE) int pageSize,
@@ -54,7 +58,8 @@ public ResponseEntity<PageableData<UserVm>> getUser (
         return ResponseEntity.ok().body(userService.getUsers(pageNum, pageSize, keyword));
     }
 
-    @PostMapping({"/admin/users"})
+    @PostMapping("/admin/users")
+    @Operation(method = "POST", summary = "Save information of user", description ="Send a request via API to save user" )
     @ApiResponses(value = {
             @ApiResponse(responseCode = "201", description = "Created", content =
                 @Content(schema = @Schema(implementation = UserVm.class))),
@@ -67,6 +72,7 @@ public ResponseEntity<UserVm> create (@Valid @RequestBody UserPostVm userPostVm)
     }
 
     @PutMapping("/admin/users/{id}")
+    @Operation(method = "PUT", summary = "Update information of user by id", description ="Send a request via API to update user" )
     @ApiResponses(value = {
             @ApiResponse(responseCode = "204", description = "No content"),
             @ApiResponse(responseCode = "404", description = "Not found", content =
@@ -82,6 +88,7 @@ public ResponseEntity<UserVm> update (@Valid @RequestBody UserPutVm userPostVm,
     }
 
     @DeleteMapping("/admin/users/{id}")
+    @Operation(method = "DELETE", summary = "Delete information of user by id", description ="Send a request via API by ROLE ADMIN to delete user" )
     public ResponseEntity<Void> delete (
             @PathVariable("id") Long id
     ) {
@@ -90,6 +97,7 @@ public ResponseEntity<Void> delete (
     }
 
     @PutMapping("/admin/users/{id}/status/{status}")
+    @Operation(method = "PUT", summary = "Update status of user by id", description ="Send a request via API to update status of user" )
     public ResponseEntity<ReviewVM> updateReview(@PathVariable("status") boolean status, @PathVariable("id") Long userId){
         userService.updateStatus(status, userId);
         return ResponseEntity.noContent().build();