Skip to content

Commit

Permalink
πŸ“ Docs: μŠ€μ›¨κ±° λͺ…μ„Έ μˆ˜μ •
Browse files Browse the repository at this point in the history
  • Loading branch information
HyoBN committed Jul 10, 2024
1 parent 75653e6 commit ef742ea
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,29 @@ public class InvitationApi {
private final InvitationService invitationService;

@GetMapping("/invitation")
@Operation(summary = "μ΄ˆλŒ€μž₯ 쑰회 \uD83D\uDD11βœ…", description = "λ‚΄κ°€ 받은 μ΄ˆλŒ€μž₯을 μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "μ΄ˆλŒ€μž₯ 쑰회 πŸ”‘ βœ…", description = "λ‚΄κ°€ 받은 μ΄ˆλŒ€μž₯을 μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<InvitationResponseDTO.getInvitations> getInvitations(
@AuthMember @Parameter(hidden = true) User user
) {
return CommonResponse.onSuccess(invitationService.getInvitations(user));
}

@GetMapping("/availableInvitation")
@Operation(summary = "μ†Œμœ ν•œ μ΄ˆλŒ€μž₯ 개수 및 κ²Œμ΄μ§€ 쑰회 \uD83D\uDD11βœ…", description = "μ†Œμœ ν•œ μ΄ˆλŒ€μž₯ 개수 및 κ²Œμ΄μ§€λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "μ†Œμœ ν•œ μ΄ˆλŒ€μž₯ 개수 및 κ²Œμ΄μ§€ 쑰회 πŸ”‘ βœ…", description = "μ†Œμœ ν•œ μ΄ˆλŒ€μž₯ 개수 및 κ²Œμ΄μ§€λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<InvitationResponseDTO.myInvitationInfo> getAvailableInvitation(@AuthMember @Parameter(hidden = true) User user){

return CommonResponse.onSuccess(invitationService.getMyInvitationInfo(user));
}

@PostMapping("/invitations/accept")
@Operation(summary = "μ΄ˆλŒ€μž₯을 μˆ˜λ½ν• μ§€ κ±°μ ˆν• μ§€ κ²°μ • \uD83D\uDD11βœ…", description = "μ΄ˆλŒ€μž₯을 μˆ˜λ½ν• μ§€ κ±°μ ˆν• μ§€ κ²°μ •ν•˜λŠ” API μž…λ‹ˆλ‹€.")
@Operation(summary = "μ΄ˆλŒ€μž₯을 μˆ˜λ½ν• μ§€ κ±°μ ˆν• μ§€ κ²°μ • πŸ”‘ βœ…", description = "μ΄ˆλŒ€μž₯을 μˆ˜λ½ν• μ§€ κ±°μ ˆν• μ§€ κ²°μ •ν•˜λŠ” API μž…λ‹ˆλ‹€.")
public CommonResponse<InvitationResponseDTO.invitationAccept> acceptInvitation(
@AuthMember @Parameter(hidden = true) User user, @RequestBody InvitationRequestDTO.invitationAcceptDecision request) {
return CommonResponse.onSuccess(invitationService.decisionInvitation(user, request));
}

@PostMapping("/invitation")
@Operation(summary = "μ΄ˆλŒ€ν•˜κΈ° API \uD83D\uDD11βœ… πŸ”‘", description = "μ΄ˆλŒ€ν•˜κΈ° API μž…λ‹ˆλ‹€. μ΄ˆλŒ€ ν›„ λ¬Έμžλ‚˜ μΉ΄μΉ΄μ˜€ν†‘ λ³΄λ‚΄λŠ” 것과 λ³„κ°œλ‘œ API 호좜 λΆ€νƒλ“œλ¦½λ‹ˆλ‹·")
@Operation(summary = "μ΄ˆλŒ€ν•˜κΈ° API βœ… πŸ”‘", description = "μ΄ˆλŒ€ν•˜κΈ° API μž…λ‹ˆλ‹€. μ΄ˆλŒ€ ν›„ λ¬Έμžλ‚˜ μΉ΄μΉ΄μ˜€ν†‘ λ³΄λ‚΄λŠ” 것과 λ³„κ°œλ‘œ API 호좜 λΆ€νƒλ“œλ¦½λ‹ˆλ‹·")
public CommonResponse<InvitationResponseDTO.createInvitation> createInvitation(
@AuthMember @Parameter(hidden = true)User user, @RequestBody InvitationRequestDTO.createInvitation request
){
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class MemberApi {
private final PostService postService;

@PostMapping("/members/register")
@Operation(summary = "νŠΈλ¦¬ν•˜μš°μŠ€ νšŒμ›κ°€μž… \uD83D\uDD11 πŸ”‘ βœ…", description = "νŠΈλ¦¬ν•˜μš°μŠ€ λ©€λ²„λ‘œ κ°€μž…ν•©λ‹ˆλ‹€.")
@Operation(summary = "νŠΈλ¦¬ν•˜μš°μŠ€ νšŒμ›κ°€μž… πŸ”‘ βœ…", description = "νŠΈλ¦¬ν•˜μš°μŠ€ λ©€λ²„λ‘œ κ°€μž…ν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.registerMember> registerTreehouseMember(
@RequestBody final MemberRequestDTO.registerMember request,
@AuthMember @Parameter(hidden = true) User user
Expand All @@ -36,7 +36,7 @@ public CommonResponse<MemberResponseDTO.registerMember> registerTreehouseMember(
}

@GetMapping("/treehouses/{treehouseId}/profiles/myProfile")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ 쑰회 \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ 쑰회 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.getProfile> getMyProfile(
@PathVariable final Long treehouseId,
@AuthMember @Parameter(hidden = true) User user
Expand All @@ -45,7 +45,7 @@ public CommonResponse<MemberResponseDTO.getProfile> getMyProfile(
}

@GetMapping("/treehouses/{treehouseId}/profiles/{memberId}")
@Operation(summary = "멀버 ν”„λ‘œν•„ 쑰회 \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • λ©€λ²„μ˜ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "멀버 ν”„λ‘œν•„ 쑰회 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • λ©€λ²„μ˜ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.getProfile> getMemberProfile(
@PathVariable(name = "treehouseId") Long treehouseId,
@PathVariable(name = "memberId") Long memberId,
Expand All @@ -56,7 +56,7 @@ public CommonResponse<MemberResponseDTO.getProfile> getMemberProfile(


@PatchMapping("/treehouses/{treehouseId}/profiles/myProfile")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ μˆ˜μ • \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μˆ˜μ •ν•©λ‹ˆλ‹€.")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ μˆ˜μ • πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μˆ˜μ •ν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.updateProfile> updateProfile(
@PathVariable final Long treehouseId,
@RequestBody final MemberRequestDTO.updateProfile request,
Expand All @@ -66,7 +66,7 @@ public CommonResponse<MemberResponseDTO.updateProfile> updateProfile(
}

@GetMapping("/treehouses/{treehouseId}/profiles/{memberId}/posts")
@Operation(summary = "멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ 쑰회 \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • 멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ 쑰회 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • 멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<PostResponseDTO.getMemberPostList> getPosts(
@PathVariable(name = "treehouseId") Long treehouseId,
@PathVariable(name = "memberId") Long memberId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class NotificationApi {
private final NotificationService notificationService;

@GetMapping("/users/notifications")
@Operation(summary = "μ•Œλ¦Ό 쑰회 \uD83D\uDD11πŸ”‘ βœ…", description = "μ‚¬μš©μžμ˜ μ•Œλ¦Όμ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "μ•Œλ¦Ό 쑰회 πŸ”‘ βœ…", description = "μ‚¬μš©μžμ˜ μ•Œλ¦Όμ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<NotificationResponseDTO.getNotifications> getNotifications(
@AuthMember @Parameter(hidden = true) User user
){
Expand Down

0 comments on commit ef742ea

Please sign in to comment.