Skip to content

Commit

Permalink
Merge pull request #82 from Team-Shaka/feat/79
Browse files Browse the repository at this point in the history
📝 Docs: 스웨거 명세 수정
  • Loading branch information
HyoBN authored Jul 10, 2024
2 parents d76c526 + ef742ea commit 412bcf3
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 412bcf3

Please sign in to comment.