Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/backing-tracks")
@Tag(name = "백킹트랙(BackinTrack)", description = "백킹트랙 생성, 수정 및 조회 api")
@Tag(name = "백킹트랙", description = "백킹트랙 생성, 수정 및 조회 API")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟠 P2

문제상황: Tag의 description이 "{도메인명} API" 짧은 형태로 안 바뀌고, 기존 긴 설명 문구에 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).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

넵! 수정했습니다!

public class BackingTrackController {

private final BackingTrackService backingTrackService;

@Operation(
summary = "백킹트랙 생성",
summary = "백킹트랙 생성 API",
description = "트랙명, 장르, Key, 조성, BPM, 트랙 유형, 공개 범위, 난이도 등의 정보를 입력받아 저장"
)
@PostMapping
Expand All @@ -56,7 +56,7 @@ public ApiResponse<BackingTrackCreateResponseDTO.CreateResultDTO> createBackingT
}

@Operation(
summary = "백킹트랙 오디오 파일 업로드 URL 발급",
summary = "백킹트랙 오디오 파일 업로드 URL 발급 API",
description = """
백킹트랙 생성 시 첨부할 오디오 파일을 S3에 직접 업로드하기 위한
Presigned PUT URL을 발급합니다.
Expand All @@ -79,7 +79,7 @@ public ApiResponse<BackingTrackUploadUrlResponse> createAudioUploadUrl(
}

@Operation(
summary = "백킹트랙 수정",
summary = "백킹트랙 수정 API",
description = "트랙의 생성자가 본인일 때, 트랙의 정보를 수정"
)
@PutMapping("/{backingTrackId}")
Expand All @@ -95,7 +95,7 @@ public ApiResponse<BackingTrackUpdateResponseDTO.UpdateResultDTO> updateBackingT
}

@Operation(
summary = "백킹트랙 재생 수 증가",
summary = "백킹트랙 재생 수 증가 API",
description = "백킹트랙 기반 연주 후 AI 분석 응답 생성이 완료된 경우, 해당 백킹트랙의 재생 수를 1 증가"
)
@PatchMapping("/{backingTrackId}/play-count")
Expand All @@ -110,7 +110,7 @@ public ApiResponse<PlayCountIncreaseResponseDTO.IncreaseResponseDTO> increasePla
}

@Operation(
summary = "백킹트랙 목록 조회",
summary = "백킹트랙 목록 조회 API",
description = "사용자가 연주 가능한 백킹트랙 목록을 카드뷰 형태로 조회하는 API\n" +
"공개 범위와 사용자를 고려하여 필터 후 커서 기반 페이징"
)
Expand All @@ -125,7 +125,7 @@ public ApiResponse<BackingTrackListResponseDTO.ListResponseDTO> getBackingTracks
}

@Operation(
summary = "백킹트랙 상세 조회",
summary = "백킹트랙 상세 조회 API",
description = "사용자가 선택한 백킹트랙의 상세 정보를 조회"
)
@GetMapping("/{backingTrackId}")
Expand All @@ -139,7 +139,7 @@ public ApiResponse<BackingTrackDetailResponseDTO.DetailResponseDTO> getBackingTr
}

@Operation(
summary = "추천 백킹크랙 조회",
summary = "추천 백킹트랙 조회API",
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
description = "최근 1주일 기준으로 AI 분석이 완료(COMPLETED)된 백킹트랙 중 playCount가 높은 TOP3 백킹트랙을 조회\n" +
"playCount 내림차순으로 정렬"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
@RestController
@RequestMapping("/api/notifications")
@RequiredArgsConstructor
@Tag(name = "알림(Notification)", description = "알림 조회 및 읽음 처리 api")
@Tag(name = "알림", description = "알림 조회 및 읽음 처리 API")
public class NotificationController {

private final NotificationService notificationService;

@Operation(
summary = "알림 목록 조회",
summary = "알림 목록 조회 API",
description = "사용자의 알림 화면을 켤 때, 로그인한 사용자에게 온 알림 리스트를 기본적으로 최신 순으로 반환합니다."
)
@GetMapping
Expand All @@ -40,7 +40,7 @@ public ApiResponse<NotificationListResponseDTO> getNotifications(
}

@Operation(
summary = "알림 읽음 처리",
summary = "알림 읽음 처리 API",
description = "해당 알림의 상태를 읽음으로 변경합니다."
)
@PatchMapping("/{notificationId}/read")
Expand All @@ -54,7 +54,7 @@ public ApiResponse<Void> readNotification(
}

@Operation(
summary = "알림 전체 읽음 처리",
summary = "알림 전체 읽음 처리 API",
description = "사용자의 미확인 상태인 알림 전체 읽음 처리"
)
@PatchMapping("/read-all")
Expand All @@ -66,7 +66,7 @@ public ApiResponse<Void> readAllNotifications(
}

@Operation(
summary = "안 읽은 알림 여부 확인 (사이드바 뱃지용)",
summary = "안 읽은 알림 여부 확인 (사이드바 뱃지용) API",
description = "미확인 상태인 알림의 존재 여부 확인"
)
@GetMapping("/unread-status")
Expand Down