Skip to content

Commit

Permalink
refactor(controller): 페이지네이션 정렬에 사용가능한 칼럼 설명 추가 #354
Browse files Browse the repository at this point in the history
  • Loading branch information
mingmingmon committed May 28, 2024
1 parent 1e39ccf commit 3fc911a
Show file tree
Hide file tree
Showing 28 changed files with 94 additions and 47 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ public ApiResponse<Long> createAccuse(
@Operation(summary = "[A] 신고 내역 조회(신고 대상, 처리 상태 기준)", description = "ROLE_ADMIN 이상의 권한이 필요함<br>" +
"2개의 파라미터를 자유롭게 조합하여 필터링 가능<br>" +
"신고 대상, 처리 상태 중 하나라도 입력하지 않으면 전체 조회됨<br>" +
"누적 횟수 기준으로 정렬할지 여부를 선택할 수 있음")
"누적 횟수 기준으로 정렬할지 여부를 선택할 수 있음<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, memberId, targetReferenceId")
@Secured({"ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("")
public ApiResponse<PagedResponseDto<AccuseResponseDto>> getAccusesByConditions(
Expand All @@ -70,7 +71,8 @@ public ApiResponse<PagedResponseDto<AccuseResponseDto>> getAccusesByConditions(
return ApiResponse.success(accuses);
}

@Operation(summary = "[U] 나의 신고 내역 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 나의 신고 내역 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, memberId, targetReferenceId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/my")
public ApiResponse<PagedResponseDto<AccuseMyResponseDto>> getMyAccuses(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ public ApiResponse<Long> addSchedule(
}

@Operation(summary = "[U] 활동 멤버 및 지원서 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"관리자 또는 리더만 조회 가능")
"관리자 또는 리더만 조회 가능<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, activityGroupId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/members")
public ApiResponse<PagedResponseDto<ActivityGroupMemberWithApplyReasonResponseDto>> getApplyGroupMemberList(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ public ApiResponse<Long> createActivityGroupBoard(
return ApiResponse.success(id);
}

@Operation(summary = "[U] 활동 그룹 게시판 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 활동 그룹 게시판 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, activityGroupId, dueDateTime, parentId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/list")
public ApiResponse<PagedResponseDto<ActivityGroupBoardResponseDto>> getActivityGroupBoardList(
Expand All @@ -88,7 +89,8 @@ public ApiResponse<ActivityGroupBoardResponseDto> getActivityGroupBoardById(
return ApiResponse.success(board);
}

@Operation(summary = "[U] 활동 그룹 ID에 대한 카테고리별 게시판 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 활동 그룹 ID에 대한 카테고리별 게시판 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, activityGroupId, dueDateTime, parentId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/by-category")
public ApiResponse<PagedResponseDto<ActivityGroupBoardResponseDto>> getActivityGroupBoardByCategory(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ public class ActivityGroupMemberController {

private final ActivityGroupMemberService activityGroupMemberService;

@Operation(summary = "활동 전체 목록 조회", description = "ROLE_ANONYMOUS 이상의 권한이 필요함")
@Operation(summary = "활동 전체 목록 조회", description = "ROLE_ANONYMOUS 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, endDate, startDate")
@GetMapping("")
public ApiResponse<PagedResponseDto<ActivityGroupResponseDto>> getActivityGroups(
@RequestParam(name = "page", defaultValue = "0") int page,
Expand Down Expand Up @@ -91,7 +92,8 @@ public ApiResponse<PagedResponseDto<ActivityGroupStatusResponseDto>> getActivity
return ApiResponse.success(activityGroups);
}

@Operation(summary = "카테고리별 활동 목록 조회", description = "ROLE_ANONYMOUS 이상의 권한이 필요함")
@Operation(summary = "카테고리별 활동 목록 조회", description = "ROLE_ANONYMOUS 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, endDate, startDate")
@GetMapping("/list")
public ApiResponse<PagedResponseDto<ActivityGroupResponseDto>> getActivityGroupsByCategory(
@RequestParam(name = "category") ActivityGroupCategory category,
Expand All @@ -105,7 +107,8 @@ public ApiResponse<PagedResponseDto<ActivityGroupResponseDto>> getActivityGroups
return ApiResponse.success(activityGroups);
}

@Operation(summary = "[U] 활동 일정 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 활동 일정 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, endDate, startDate")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/schedule")
public ApiResponse<PagedResponseDto<GroupScheduleDto>> getGroupScheduleList(
Expand All @@ -121,7 +124,8 @@ public ApiResponse<PagedResponseDto<GroupScheduleDto>> getGroupScheduleList(
}

@Operation(summary = "[U] 활동 멤버 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"활동에 참여(수락)된 멤버만 조회 가능")
"활동에 참여(수락)된 멤버만 조회 가능<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, endDate, startDate")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/members")
public ApiResponse<PagedResponseDto<GroupMemberResponseDto>> getActivityGroupMemberList(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ public ApiResponse<Long> writeReport(
return ApiResponse.success(id);
}

@Operation(summary = "[U] 특정 그룹의 활동 보고서 전체 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 특정 그룹의 활동 보고서 전체 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, activityGroupId")
@GetMapping("")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
public ApiResponse<PagedResponseDto<ActivityGroupReportResponseDto>> getReports(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ public ApiResponse<Long> checkInAttendance(
return ApiResponse.success(id);
}

@Operation(summary = "[U] 내 출석기록 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 내 출석기록 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, activityDate, groupId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping({"/my-attendance"})
public ApiResponse<PagedResponseDto<AttendanceResponseDto>> searchMyAttendance(
Expand All @@ -79,7 +80,8 @@ public ApiResponse<PagedResponseDto<AttendanceResponseDto>> searchMyAttendance(
return ApiResponse.success(myAttendances);
}

@Operation(summary = "[U] 특정 그룹의 출석기록 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 특정 그룹의 출석기록 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, activityDate, groupId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping({"/group-attendance"})
public ApiResponse<PagedResponseDto<AttendanceResponseDto>> searchGroupAttendance(
Expand All @@ -104,7 +106,8 @@ public ApiResponse<Long> writeAbsentExcuse(
return ApiResponse.success(id);
}

@Operation(summary = "[U] 그룹의 불참 사유서 열람", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 그룹의 불참 사유서 열람", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, activityDate, groupId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping({"/absent/{activityGroupId}"})
public ApiResponse<PagedResponseDto<AbsentResponseDto>> getActivityGroupAbsentExcuses(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ public ApiResponse<Long> createActivityPhoto(
}

@Operation(summary = "활동 사진 목록 조회", description = "ROLE_ANONYMOUS 이상의 권한이 필요함<br> " +
"공개 여부를 입력하지 않으면 전체 조회됨")
"공개 여부를 입력하지 않으면 전체 조회됨<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, date, groupId, memberId")
@GetMapping("")
public ApiResponse<PagedResponseDto<ActivityPhotoResponseDto>> getActivityPhotosByConditions(
@RequestParam(name = "isPublic", required = false) Boolean isPublic,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ public ApiResponse<String> createApplication(

@Operation(summary = "[A] 지원자 목록 조회(모집 일정 ID, 지원자 ID, 합격 여부 기준)", description = "ROLE_ADMIN 이상의 권한이 필요함<br>" +
"3개의 파라미터를 자유롭게 조합하여 필터링 가능<br>" +
"모집 일정 ID, 지원자 ID, 합격 여부 중 하나라도 입력하지 않으면 전체 조회됨")
"모집 일정 ID, 지원자 ID, 합격 여부 중 하나라도 입력하지 않으면 전체 조회됨<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, birth, grade, recruitmentId, studentId")
@Secured({"ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/conditions")
public ApiResponse<PagedResponseDto<ApplicationResponseDto>> getApplicationsByConditions(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ public ApiResponse<Long> createAward(

@Operation(summary = "[U] 수상 이력 조회(학번, 연도 기준)", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"2개의 파라미터를 자유롭게 조합하여 필터링 가능<br>" +
"학번, 연도 중 하나라도 입력하지 않으면 전체 조회됨")
"학번, 연도 중 하나라도 입력하지 않으면 전체 조회됨<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, awardDate, grade, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("")
public ApiResponse<PagedResponseDto<AwardResponseDto>> getAwardsByConditions(
Expand All @@ -69,7 +70,8 @@ public ApiResponse<PagedResponseDto<AwardResponseDto>> getAwardsByConditions(
return ApiResponse.success(awards);
}

@Operation(summary = "[U] 나의 수상 이력 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 나의 수상 이력 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, awardDate, grade, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/my")
public ApiResponse<PagedResponseDto<AwardResponseDto>> getMyAwards(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ public ApiResponse<String> addBlacklistedIp(
return ApiResponse.success(addedIp);
}

@Operation(summary = "[A] 블랙리스트 IP 목록 조회", description = "ROLE_ADMIN 이상의 권한이 필요함")
@Operation(summary = "[A] 블랙리스트 IP 목록 조회", description = "ROLE_ADMIN 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, ipAddress")
@Secured({"ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("")
public ApiResponse<PagedResponseDto<BlacklistIp>> getBlacklistedIps(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ public ApiResponse<Long> createBlog(

@Operation(summary = "[U] 블로그 포스트 조회(제목, 작성자명 기준)", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"2개의 파라미터를 자유롭게 조합하여 필터링 가능<br>" +
"제목, 작성자명 중 하나라도 입력하지 않으면 전체 조회됨")
"제목, 작성자명 중 하나라도 입력하지 않으면 전체 조회됨<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("")
public ApiResponse<PagedResponseDto<BlogResponseDto>> getBlogsByConditions(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ public ApiResponse<String> createBoard(
}

@GetMapping("")
@Operation(summary = "[U] 커뮤니티 게시글 목록 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 커뮤니티 게시글 목록 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
public ApiResponse<PagedResponseDto<BoardListResponseDto>> getBoards(
@RequestParam(name = "page", defaultValue = "0") int page,
Expand All @@ -80,7 +81,8 @@ public ApiResponse<BoardDetailsResponseDto> getBoardDetails(
}

@GetMapping("/my-boards")
@Operation(summary = "[U] 내가 쓴 커뮤니티 게시글 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 내가 쓴 커뮤니티 게시글 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
public ApiResponse<PagedResponseDto<BoardMyResponseDto>> getMyBoards(
@RequestParam(name = "page", defaultValue = "0") int page,
Expand All @@ -94,7 +96,8 @@ public ApiResponse<PagedResponseDto<BoardMyResponseDto>> getMyBoards(
}

@GetMapping("/category")
@Operation(summary = "[U] 커뮤니티 게시글 카테고리별 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 커뮤니티 게시글 카테고리별 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
public ApiResponse<PagedResponseDto<BoardCategoryResponseDto>> getBoardsByCategory(
@RequestParam(name = "category") BoardCategory category,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ public ApiResponse<Long> createBook(

@Operation(summary = "[U] 도서 목록 조회(제목, 카테고리, 출판사, 대여자 ID, 대여자 이름 기준)", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"5개의 파라미터를 자유롭게 조합하여 필터링 가능<br>" +
"제목, 카테고리, 출판사, 대여자 ID, 대여자 이름 중 하나라도 입력하지 않으면 전체 조회됨")
"제목, 카테고리, 출판사, 대여자 ID, 대여자 이름 중 하나라도 입력하지 않으면 전체 조회됨<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("")
public ApiResponse<PagedResponseDto<BookResponseDto>> getBooksByConditions(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ public ApiResponse<Long> rejectBookLoan(

@Operation(summary = "[U] 도서 대출 내역 조회(도서 ID, 대출자 ID, 대출 상태 기준)", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"3개의 파라미터를 자유롭게 조합하여 필터링 가능<br>" +
"도서 ID, 대출자 ID, 대출 가능 여부 중 하나라도 입력하지 않으면 전체 조회됨")
"도서 ID, 대출자 ID, 대출 가능 여부 중 하나라도 입력하지 않으면 전체 조회됨<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, bookId, borrowedAt, dueDate, loanExtensionCount, returnedAt, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/conditions")
public ApiResponse<PagedResponseDto<BookLoanRecordResponseDto>> getBookLoanRecordsByConditions(
Expand All @@ -110,7 +111,8 @@ public ApiResponse<PagedResponseDto<BookLoanRecordResponseDto>> getBookLoanRecor
return ApiResponse.success(bookLoanRecords);
}

@Operation(summary = "[A] 도서 연체자 조회", description = "ROLE_ADMIN 이상의 권한이 필요함")
@Operation(summary = "[A] 도서 연체자 조회", description = "ROLE_ADMIN 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, bookId, borrowedAt, dueDate, loanExtensionCount, returnedAt, memberId")
@Secured({"ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/overdue")
public ApiResponse<PagedResponseDto<BookLoanRecordOverdueResponseDto>> getOverdueBookLoanRecords(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ public ApiResponse<Long> createComment(
return ApiResponse.success(id);
}

@Operation(summary = "[U] 댓글 목록 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 댓글 목록 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, boardId, likes, parentId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/{boardId}")
public ApiResponse<PagedResponseDto<CommentResponseDto>> getComments(
Expand All @@ -70,7 +71,8 @@ public ApiResponse<PagedResponseDto<CommentResponseDto>> getComments(
return ApiResponse.success(comments);
}

@Operation(summary = "[U] 나의 댓글 조회", description = "ROLE_USER 이상의 권한이 필요함")
@Operation(summary = "[U] 나의 댓글 조회", description = "ROLE_USER 이상의 권한이 필요함<br>" +
"페이지네이션 정렬에 사용할 수 있는 칼럼 : createdAt, id, updatedAt, boardId, likes, parentId, memberId")
@Secured({"ROLE_USER", "ROLE_ADMIN", "ROLE_SUPER"})
@GetMapping("/my-comments")
public ApiResponse<PagedResponseDto<CommentMyResponseDto>> getMyComments(
Expand Down
Loading

0 comments on commit 3fc911a

Please sign in to comment.