Skip to content

Commit

Permalink
Update API document
Browse files Browse the repository at this point in the history
๋ˆ„๋ฝ๋œ API ๋ฌธ์„œ, ๋ˆ„๋ฝ๋œ hidden ์ฒ˜๋ฆฌ ์ถ”๊ฐ€
  • Loading branch information
hyh1016 committed Aug 29, 2024
1 parent cbd41ff commit 403717e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.multipart.MultipartFile;

Expand Down Expand Up @@ -89,7 +90,21 @@ ResponseEntity<UpdateUserLocationResponse> updateLocation(
)
ResponseEntity<ReportUserResponse> reportUser(
@RequestBody ReportUserRequest request,
UserInfo userInfo
@Parameter(hidden = true) UserInfo userInfo
);

@Operation(summary = "์œ ์ € ์‚ญ์ œ", description = "์œ ์ €๋ฅผ ์‚ญ์ œํ•˜๋Š” API")
@ApiResponse(
responseCode = "204",
description = "์œ ์ € ์‚ญ์ œ ์™„๋ฃŒ"
)
ResponseEntity<Void> deleteUser(@Parameter(hidden = true) UserInfo userInfo);

@Operation(summary = "์‚ญ์ œ๋œ ์œ ์ € ๋ณต๊ตฌ", description = "์‚ญ์ œ๋œ ์œ ์ €๋ฅผ ๋ณต๊ตฌํ•˜๋Š” API")
@ApiResponse(
responseCode = "204",
description = "๋ณต๊ตฌ ์™„๋ฃŒ"
)
ResponseEntity<Void> restoreUser(@PathVariable long userId);

}
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,9 @@ ResponseEntity<PatchWalkLogResponse> update(
)
ResponseEntity<ReportWalkLogResponse> reportWalkLog(
@RequestBody ReportWalkLogRequest request,
UserInfo userInfo
@Parameter(hidden = true) UserInfo userInfo
);


@Operation(summary = "์‚ฐ์ฑ… ๊ธฐ๋ก ์ƒ์„ธ ์กฐํšŒ", description = "์‚ฐ์ฑ… ๊ธฐ๋ก์„ ์ƒ์„ธ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.")
@ApiResponse(
responseCode = "200",
Expand Down

0 comments on commit 403717e

Please sign in to comment.