[REFACTOR] Swagger 문서 형식 통일 (백킹트랙/알림) - #206
Conversation
|
Warning Review limit reached
Next review available in: 52 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughBackingTrackController와 NotificationController의 Swagger 태그 및 API 요약 문구를 통일했습니다. 오타와 영문 표기를 수정했습니다. 실행 로직과 공개 메서드 시그니처는 변경하지 않았습니다. ChangesSwagger 문서 형식 통일
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@src/main/java/com/mr/domain/backingtrack/controller/BackingTrackController.java`:
- Line 142: Update the summary in the BackingTrackController API annotation from
“추천 백킹트랙 조회API” to “추천 백킹트랙 조회 API”, adding the space before API for consistent
OpenAPI documentation.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 62621e96-aa7b-4850-b113-fba23eb9c0fc
📒 Files selected for processing (2)
src/main/java/com/mr/domain/backingtrack/controller/BackingTrackController.javasrc/main/java/com/mr/domain/notification/controller/NotificationController.java
…ger-convention-dg
| @RequiredArgsConstructor | ||
| @RequestMapping("/api/backing-tracks") | ||
| @Tag(name = "백킹트랙(BackinTrack)", description = "백킹트랙 생성, 수정 및 조회 api") | ||
| @Tag(name = "백킹트랙", description = "백킹트랙 생성, 수정 및 조회 API") |
There was a problem hiding this comment.
🟠 P2
문제상황: Tag의 description이 "{도메인명} API" 짧은 형태로 안 바뀌고, 기존 긴 설명 문구에 API만 이어붙인 상태로 남아있음.
- [BackingTrackController.java:38](https://github.com/Musereview/BE/blob/refactor/%23200-swagger-convention-dg/src/main/java/com/mr/domain/backingtrack/controller/BackingTrackController.java#L38) —
@Tag(name = "백킹트랙", description = "백킹트랙 생성, 수정 및 조회 API") - [NotificationController.java:23](https://github.com/Musereview/BE/blob/refactor/%23200-swagger-convention-dg/src/main/java/com/mr/domain/notification/controller/NotificationController.java#L23) —
@Tag(name = "알림", description = "알림 조회 및 읽음 처리 API")
문제가 되는 이유:
이번 #200 이슈의 양식(은우님이 공유한 예시 @Tag(name = "인증", description = "인증 API"))은
description을 {도메인명} API 짧은 형태로 통일하는 게 핵심인데
이 PR은 Tag name의 영문 괄호 제거·대소문자(api→API)만 맞추고
description은 기존 긴 설명을 그대로 유지함.
이미 형식 통일된 다른 도메인(학습/사용자/분석/AI멘토 등)은 전부 짧은 형태라 이 PR만 형식이 다르게 남게 됨.
수정 방향: description = "백킹트랙 API", description = "알림 API"로 축약.
나머지는 깔끔해요 — summary 8개(백킹트랙) + 4개(알림) 전부 " API" 붙었고, 빠진 엔드포인트 없고, description 내용 자체는 안 건드려서 안전하고, develop이랑 충돌도 없습니다(mergeable: true).
There was a problem hiding this comment.
넵! 수정했습니다!
ownue
left a comment
ownue
left a comment
There was a problem hiding this comment.
수연이가 남겨준 리뷰 맞춰서(단순 컨벤션 통일) 수정하신 뒤 직접 머지하시면 되겠습니다~! 수고하셨어요!
3 participants
📍 개요
⛓️💥 관련 이슈
🛠️ 작업 내용
🔥 리뷰 요청 사항
✅ 체크리스트
📎 참고 사항
Summary by CodeRabbit
API표기를 추가했습니다.