Skip to content

[FEAT] V2 모임 스웨거 업데이트 #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LimdaeIl merged 1 commit into from
Dec 23, 2025
Merged

[FEAT] V2 모임 스웨거 업데이트 #155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions src/main/java/team/wego/wegobackend/group/v2/presentation/GroupV2ControllerDocs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
import java.util.List;
import org.springframework.http.ResponseEntity;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.web.bind.annotation.GetMapping;
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This import is only needed because of the incorrectly placed @GetMapping annotations in the interface. Since mapping annotations should only be in the implementation class (GroupV2Controller) and not in the documentation interface (GroupV2ControllerDocs), this import should be removed from the interface file.

Suggested change
import org.springframework.web.bind.annotation.GetMapping;

Copilot uses AI. Check for mistakes.
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This import is only needed because of the incorrectly placed @PostMapping annotations in the interface. Since mapping annotations should only be in the implementation class (GroupV2Controller) and not in the documentation interface (GroupV2ControllerDocs), this import should be removed from the interface file.

Suggested change
import org.springframework.web.bind.annotation.PostMapping;

Copilot uses AI. Check for mistakes.
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import team.wego.wegobackend.common.response.ApiResponse;
Expand All @@ -16,9 +18,13 @@
import team.wego.wegobackend.group.v2.application.dto.request.UpdateGroupV2Request;
import team.wego.wegobackend.group.v2.application.dto.response.AttendanceGroupV2Response;
import team.wego.wegobackend.group.v2.application.dto.response.CreateGroupV2Response;
import team.wego.wegobackend.group.v2.application.dto.response.GetBanTargetsResponse;
import team.wego.wegobackend.group.v2.application.dto.response.GetBannedTargetsResponse;
import team.wego.wegobackend.group.v2.application.dto.response.GetGroupListV2Response;
import team.wego.wegobackend.group.v2.application.dto.response.GetGroupV2Response;
import team.wego.wegobackend.group.v2.application.dto.response.GetKickTargetsResponse;
import team.wego.wegobackend.group.v2.application.dto.response.GetMyGroupListV2Response;
import team.wego.wegobackend.group.v2.application.dto.response.GroupUserV2StatusResponse;
import team.wego.wegobackend.group.v2.application.dto.response.UpdateGroupV2Response;
import team.wego.wegobackend.group.v2.domain.entity.GroupUserV2Status;
import team.wego.wegobackend.group.v2.domain.entity.GroupV2Status;
Expand Down Expand Up @@ -144,4 +150,117 @@ ResponseEntity<Void> delete(@AuthenticationPrincipal CustomUserDetails userDetai
@PathVariable Long groupId);


@Operation(
summary = "승인 API (HOST/권한자)",
description = """
승인제(APPROVAL_REQUIRED) 모임에서 PENDING 상태의 참여 신청자를 승인합니다.
- PENDING -> ATTEND
- 권한: HOST 또는 정책상 승인 가능한 권한자
"""
)
@PostMapping("/{groupId}/attendance/{targetUserId}/approve")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @PostMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GroupUserV2StatusResponse>> approve(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId,
@PathVariable Long targetUserId
);

@Operation(
summary = "거절 API (HOST/권한자)",
description = """
승인제(APPROVAL_REQUIRED) 모임에서 PENDING 상태의 참여 신청자를 거절합니다.
- PENDING -> REJECTED
- 권한: HOST 또는 정책상 거절 가능한 권한자
"""
)
@PostMapping("/{groupId}/attendance/{targetUserId}/reject")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @PostMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GroupUserV2StatusResponse>> reject(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId,
@PathVariable Long targetUserId
);

@Operation(
summary = "강퇴 API (HOST)",
description = """
모임 참여자(ATTEND)를 강퇴합니다.
- ATTEND -> KICKED
- 권한: HOST
"""
)
@PostMapping("/{groupId}/attendance/{targetUserId}/kick")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @PostMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GroupUserV2StatusResponse>> kick(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId,
@PathVariable Long targetUserId
);

@Operation(
summary = "차단(BAN) API (HOST)",
description = """
모임 참여자(ATTEND)를 차단합니다.
- ATTEND -> BANNED
- 권한: HOST
"""
)
@PostMapping("/{groupId}/attendance/{targetUserId}/ban")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @PostMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GroupUserV2StatusResponse>> ban(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId,
@PathVariable Long targetUserId
);

@Operation(
summary = "차단 해제(UNBAN) API (HOST)",
description = """
차단(BANNED) 상태의 유저를 차단 해제합니다.
- BANNED -> KICKED (재참여는 유저가 attend로 진행)
- 권한: HOST
"""
)
@PostMapping("/{groupId}/attendance/{targetUserId}/unban")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @PostMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Suggested change
@PostMapping("/{groupId}/attendance/{targetUserId}/unban")

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GroupUserV2StatusResponse>> unban(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId,
@PathVariable Long targetUserId
);

@Operation(
summary = "강퇴 대상 조회 (HOST)",
description = """
강퇴 가능한 대상(현재 ATTEND 상태, HOST 제외)을 조회합니다.
- 권한: HOST
"""
)
@GetMapping("/{groupId}/attendance/kick-targets")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @GetMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Suggested change
@GetMapping("/{groupId}/attendance/kick-targets")

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GetKickTargetsResponse>> getKickTargets(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId
);

@Operation(
summary = "차단 대상 조회 (HOST)",
description = """
차단 가능한 대상(현재 ATTEND 상태, HOST 제외)을 조회합니다.
- 권한: HOST
"""
)
@GetMapping("/{groupId}/attendance/ban-targets")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @GetMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GetBanTargetsResponse>> getBanTargets(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId
);

@Operation(
summary = "차단된 대상 조회 (HOST)",
description = """
차단(BANNED)된 대상 목록(HOST 제외)을 조회합니다.
- 권한: HOST
"""
)
@GetMapping("/{groupId}/attendance/banned-targets")
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mapping annotation @GetMapping should not be placed in the interface. Following the existing pattern in this file, mapping annotations like @PostMapping, @GetMapping, @PatchMapping, etc. should only be placed in the implementation class (GroupV2Controller), not in the documentation interface (GroupV2ControllerDocs). The interface should only contain @operation annotations for Swagger documentation. Please remove this annotation from the interface.

Suggested change
@GetMapping("/{groupId}/attendance/banned-targets")

Copilot uses AI. Check for mistakes.
ResponseEntity<ApiResponse<GetBannedTargetsResponse>> getBannedTargets(
@AuthenticationPrincipal CustomUserDetails userDetails,
@PathVariable Long groupId
);
}
Loading