Skip to content
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.

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

feat: 제출 가능한 과제 API 응답에 최종 수정 일시 필드 추가 #762

Merged

Conversation

Sangwook02
Copy link
Member

@Sangwook02 Sangwook02 commented Sep 4, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • 과제 최종 수정 일시 필드 추가했습니다.

📝 참고사항

📚 기타

Summary by CodeRabbit

  • 버그 수정

    • getUpcomingAssignments 메서드가 더 이상 사용되지 않음을 표시하기 위해 deprecated = true 속성이 추가되었습니다.
  • 새로운 기능

    • AssignmentSubmittableDtocommittedAt 필드가 추가되어 과제 제출에 대한 최종 수정 타임스탬프 정보를 포함할 수 있게 되었습니다.

@Sangwook02 Sangwook02 self-assigned this Sep 4, 2024
@Sangwook02 Sangwook02 requested a review from a team as a code owner September 4, 2024 13:56
@Sangwook02 Sangwook02 added the ✨ feature 새로운 기능 추가 및 수정 label Sep 4, 2024
Copy link

coderabbitai bot commented Sep 4, 2024

Walkthrough

변경 사항은 StudentStudyDetailController 클래스의 getUpcomingAssignments 메서드에 deprecated = true 속성을 추가하여 해당 메서드를 더 이상 사용하지 않도록 표시하는 것입니다. 또한, AssignmentSubmittableDto 클래스에 committedAt이라는 새로운 필드를 추가하여 과제 제출에 대한 최종 수정 타임스탬프를 포함하도록 수정되었습니다.

Changes

파일 경로 변경 요약
src/main/java/com/gdschongik/gdsc/domain/study/api/StudentStudyDetailController.java getUpcomingAssignments 메서드의 @Operation 주석에 deprecated = true 속성 추가
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentSubmittableDto.java committedAt 필드를 추가하고, 생성자와 관련 메서드를 수정하여 새로운 필드를 포함하도록 변경

Assessment against linked issues

Objective Addressed Explanation
제출가능한 과제 조회 API 응답에 최종 수정 일시 추가 (#761)

Possibly related issues

Poem

🐰
새 과제의 시간, 수정이 왔네,
오래된 메서드는 이제 잊혀지네.
최종 수정 일시, 함께 담아,
더 나은 과제, 우리를 반겨주네!
🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Sep 4, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link
Member

@AlmondBreez3 AlmondBreez3 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f7262d7 and 599e9a4.

Files selected for processing (2)
  • src/main/java/com/gdschongik/gdsc/domain/study/api/StudentStudyDetailController.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentSubmittableDto.java (3 hunks)
Additional comments not posted (5)
src/main/java/com/gdschongik/gdsc/domain/study/api/StudentStudyDetailController.java (1)

49-49: LGTM!

@Operation 어노테이션에 deprecated = true 속성을 추가하여 getUpcomingAssignments 메서드를 더 이상 사용하지 않도록 표시한 것은 좋은 변경 사항입니다. 이는 개발자들에게 해당 메서드를 새로운 코드에서 사용하지 말아야 하며 향후 버전에서 제거될 수 있음을 알리는 역할을 합니다. 메서드의 나머지 기능과 매개변수는 변경되지 않아 기존 동작을 유지하면서도 코드베이스 내에서의 상태를 변경할 수 있습니다.

src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentSubmittableDto.java (4)

22-23: LGTM!

변경 사항이 승인되었습니다.


44-45: LGTM!

변경 사항이 승인되었습니다.


50-59: LGTM!

변경 사항이 승인되었습니다.


72-72: LGTM!

변경 사항이 승인되었습니다.

Copy link
Member

@uwoobeat uwoobeat left a comment

Choose a reason for hiding this comment

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

lgtm

@@ -46,7 +46,7 @@ public ResponseEntity<List<StudyStudentCurriculumResponse>> getStudyCurriculums(
return ResponseEntity.ok(response);
}

@Operation(summary = "이번주 제출해야 할 과제 조회", description = "마감 기한이 이번주까지인 과제를 조회합니다.")
@Operation(summary = "이번주 제출해야 할 과제 조회", description = "마감 기한이 이번주까지인 과제를 조회합니다.", deprecated = true)
Copy link
Member

Choose a reason for hiding this comment

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

전체에 @Deprecated 로 걸면 IDE 단에서도 잡히고, 스웨거에서도 X로 표시되어서 별도 어노테이션으로 달면 어떨까 싶네요

Copy link

github-actions bot commented Sep 4, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 599e9a4 and 80148cc.

Files selected for processing (1)
  • src/main/java/com/gdschongik/gdsc/domain/study/api/StudentStudyDetailController.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/gdschongik/gdsc/domain/study/api/StudentStudyDetailController.java

@Sangwook02 Sangwook02 merged commit 7292f33 into develop Sep 4, 2024
1 check passed
@Sangwook02 Sangwook02 deleted the feature/761-add-committed-at-to-dashboard-response branch September 4, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ feature 새로운 기능 추가 및 수정
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ 제출가능한 과제 조회 API 응답에 최종 수정 일시 추가
3 participants