[FIX] 담당 API Swagger 문서 실제 코드/명세서 불일치 수정

[p1001q]

📍 개요

담당 API 10개 Swagger 문서를 실제 코드 동작 및 명세서와 대조해서 불일치 점검

⛓️‍💥 관련 이슈

• Closes 🐛 BugFix - 담당 API Swagger 문서 실제 코드/명세서 불일치 점검 및 수정 #126

---

🛠️ 작업 내용

• 담당 API 10개(사용자 관리 4 + 학습 6) 전부 코드/Swagger/docs/학습·사용자관리 API 명세서.md 세 기준으로 대조
• 코드 수정은 LearningPracticeDataResponseDTO의 Swagger 예시값 갱신 1건뿐(로직 변경 없음)
  — midiData 예시를 실제 확정 구조(recording/options)로, keySignature 예시를 톤+장단조 형식("C major")으로 갱신
• 나머지 불일치는 전부 문서(docs/) 쪽 문제로 확인돼 명세서만 수정:
  • AUTH_402_01 오타
  • 응답 코드값 대신 enum 이름 표기
  • is_active=true 조건 누락
  • Required 표기 오류
  • 응답 필드 설명 누락 등

---

🔥 리뷰 요청 사항

• Swagger 예시값(example=)만 바뀐 게 맞는지 실제 응답 로직/필드에 영향 없는지 확인 부탁드립니다

근데 문제 없을 거 같긴 해요

✅ 체크리스트

• 코드 컨벤션을 준수했습니다.
• 불필요한 코드 및 import를 제거했습니다.
• 예외 처리를 적용했습니다.
• 테스트를 완료했습니다.
• 관련 Issue를 연결했습니다.

---

📎 참고 사항

• 가벼운 수정이라 리뷰 부담은 없을 거 같아용 승인만 해주시면 빠르게 머지하고 싶습니당

[coderabbitai]

📝 Walkthrough

Walkthrough

LearningPracticeDataResponseDTO의 Swagger 설명과 예시를 실제 practice-data 응답 구조에 맞게 수정했습니다. 로직과 공개 선언은 변경하지 않았습니다.

Changes

Swagger 문서 동기화

Layer / File(s)	Summary
연습 데이터 응답 예시 갱신 src/main/java/com/mr/domain/learning/dto/res/LearningPracticeDataResponseDTO.java	keySignature 예시를 C에서 C major로 변경했습니다. midiData 설명과 예시를 recording 및 options를 포함하는 JSON 객체 구조로 갱신했습니다.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

• Musereview/BE#50: LearningPracticeDataResponseDTO 필드의 Swagger 설명을 수정한 PR입니다.
• Musereview/BE#55: 동일 DTO 필드의 Swagger 설명과 예시를 보완한 PR입니다.

Poem

조성에는 장단조를 담고
MIDI에는 구조를 담아
Swagger 예시가 새로 정돈됐네
코드는 그대로, 문서는 또렷하게
작은 수정, 큰 혼동 방지 🎵

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	[#126]의 담당 API 대조 및 문서 동기화 목표를 충족하며, DTO Swagger 예시도 실제 응답 구조에 맞게 갱신했습니다.
Out of Scope Changes check	✅ Passed	변경 사항은 Swagger 애노테이션과 관련 API 명세서 동기화에 한정되며, 연결 이슈와 무관한 변경은 확인되지 않습니다.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	담당 API의 Swagger 문서와 실제 코드·명세서 간 불일치를 수정하는 변경 내용을 명확하게 요약합니다.

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/#126-swagger-docs-sync

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[AIS-SG]

swagger 문서 수정하신거 잘 확인했습니다.
수고하셨습니다.