Skip to content

Conversation

@zyovn
Copy link
Member

@zyovn zyovn commented Nov 27, 2025

🔗 연관된 이슈

🚀 변경 유형

  • ✨ 기능 추가 (feature)
  • 🐛 버그 수정 (fix)
  • 📝 문서 변경 (docs)
  • ♻️ 리팩토링 (refactor)
  • 🧪 테스트 추가 / 수정 (test)
  • ⚙️ 설정 변경 (chore)

📝 작업 내용

  • 앨범 내 사진 목록 조회 업로더 프로필 이미지 schema 추가

📸 스크린샷

image

💬 리뷰 요구사항

📜 리뷰 규칙

Reviewer는 아래 P5 Rule을 참고하여 리뷰를 진행합니다.
P5 Rule을 통해 Reviewer는 Reviewee에게 리뷰의 의도를 보다 정확히 전달할 수 있습니다.

  • P1: 꼭 반영해주세요 (Comment)
  • P2: 적극적으로 고려해주세요 (Comment)
  • P3: 웬만하면 반영해 주세요 (Comment)
  • P4: 반영해도 좋고 넘어가도 좋습니다 (Approve)
  • P5: 그냥 사소한 의견입니다 (Approve)

Summary by CodeRabbit

  • 문서화
    • API 응답 예제가 업데이트되었습니다: 예시 페이로드에 프로필 이미지 URL 필드가 추가되고, 예시 내 좋아요 카운트 명칭이 "likesCnt"에서 "likeCnt"로 바뀌었습니다. 공개 API 및 런타임 동작에는 변경이 없습니다.

✏️ Tip: You can customize this high-level summary in your review settings.

@zyovn zyovn self-assigned this Nov 27, 2025
@zyovn zyovn added the 📝docs Improvements or additions to documentation label Nov 27, 2025
@zyovn zyovn linked an issue Nov 27, 2025 that may be closed by this pull request
1 task
@coderabbitai
Copy link

coderabbitai bot commented Nov 27, 2025

Walkthrough

PhotoPageResponse 클래스의 Swagger 스키마 주석 예시(JSON 페이로드)에 업로드자 profileImage 필드를 추가하고 예시의 likesCntlikeCnt로 이름을 조정했습니다. 코드 선언·런타임 로직·공개 API 서명에는 변경이 없습니다.

Changes

Cohort / File(s) 변경 요약
스키마 문서 업데이트
src/main/java/com/cheeeese/photo/dto/response/PhotoPageResponse.java
Swagger 주석의 예시 JSON에 profileImage 필드 추가, 예시 내 likesCntlikeCnt로 명칭 조정. 코드/필드 선언 및 로직은 변경 없음.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • 주로 주석(예시 페이로드) 수정이므로 리뷰 포인트가 적음
  • 확인 포인트: 예시와 실제 필드 명칭 불일치 여부(문서 일관성)

Possibly related issues

Suggested reviewers

  • dahyun24

🐰 문서에 살짝 남긴 한 줄,
프로필 빛나네 반짝 반짝,
예시가 웃음 지으면,
개발자도 미소 짓고,
코드와 문서가 다정해지네 📸✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 제목이 변경사항의 주요 내용을 정확히 반영합니다. 'docs: 앨범 내 사진 목록 조회 swagger 수정'은 Swagger 문서에서 사진 목록 조회 API의 응답 스키마(profileImage 필드 추가, likesCnt → likeCnt 이름 변경)를 수정했다는 내용을 명확하게 요약합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/#109-photo-view

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 958b4fa and 603026e.

📒 Files selected for processing (1)
  • src/main/java/com/cheeeese/photo/dto/response/PhotoPageResponse.java (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/cheeeese/photo/dto/response/PhotoPageResponse.java

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/main/java/com/cheeeese/photo/dto/response/PhotoPageResponse.java (1)

20-37: 스키마 예제의 필드명 오류를 수정해야 합니다.

PhotoListResponse 클래스를 확인한 결과, profileImage 필드는 이미 존재하므로 원래 우려사항은 해당되지 않습니다.

다만 스키마 예제에서 필드명 오류가 발견되었습니다:

  • 예제: "likesCnt": 1 (라인 30)
  • 실제 필드명: likeCnt (PhotoListResponse 라인 36)

필드명을 likeCnt로 수정하여 문서와 구현의 일관성을 맞춰주세요.

🧹 Nitpick comments (1)
src/main/java/com/cheeeese/photo/dto/response/PhotoPageResponse.java (1)

27-27: 예제 URL이 완전하지 않습니다.

Line 27의 예제 URL이 "https://say-cheese-profile.edge..." 형태로 잘려있습니다. 명확한 예제를 위해 완전한 URL 또는 표준화된 placeholder를 사용하는 것이 좋습니다.

-                            "profileImage": "https://say-cheese-profile.edge...",
+                            "profileImage": "https://say-cheese-profile.edge.cdn.example.com/profile/user123.jpg",
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c062bb and 958b4fa.

📒 Files selected for processing (1)
  • src/main/java/com/cheeeese/photo/dto/response/PhotoPageResponse.java (1 hunks)

@zyovn zyovn merged commit 4f40cf3 into develop Nov 27, 2025
1 check passed
@zyovn zyovn deleted the docs/#109-photo-view branch November 27, 2025 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: 앨범 내 사진 목록 조회 swagger 수정

2 participants