[REFACTOR] auth 도메인 설명

[kimyw1018]

📍 개요

auth 도메인 상세 수정

⛓️‍💥 관련 이슈

• ♻️ Refactor - Swagger API 문서 형식 통일 #200

---

🛠️ 작업 내용

• 각 api 설명 한줄 요약, 기능 세분화

---

✅ 체크리스트

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

---

📎 참고 사항

Summary by CodeRabbit

• 문서화
  • 인증 및 소셜 로그인 API의 Swagger/OpenAPI 요약과 설명을 간결하게 정리했습니다.
  • OAuth, 토큰, 계정 연동, 로그아웃, 회원 탈퇴 API의 성공 응답 예시를 일관된 형식으로 통일했습니다.
  • 로그인 및 토큰 응답 예시에 사용자 상태와 액세스 토큰 만료 시간 정보를 명확히 반영했습니다.

[coderabbitai]

📝 Walkthrough

Walkthrough

AuthController의 Swagger/OpenAPI 문서를 인증 API 기준으로 정리했습니다. OAuth 흐름, 토큰 응답, 계정 연동과 세션 종료 API의 설명과 예시를 갱신했습니다.

Changes

인증 API 문서

Layer / File(s)	Summary
OAuth 흐름 문서 src/main/java/com/mr/domain/auth/controller/AuthController.java	OAuth 시작 및 콜백 API의 요약, 설명, 리다이렉트 URI와 접속 기기 정보 파라미터 문서를 갱신했습니다.
토큰 발급 및 갱신 문서 src/main/java/com/mr/domain/auth/controller/AuthController.java	임시 코드 교환, 소셜 로그인, JWT 재발급 API의 설명을 정리했습니다. 성공 응답을 COMMON_200 형식으로 통일하고 tokenInfo와 accessTokenExpiresInSeconds를 반영했습니다.
계정 수명 주기 문서 src/main/java/com/mr/domain/auth/controller/AuthController.java	소셜 계정 연동, 로그아웃, 회원 탈퇴 API의 설명과 접속 기기 정보 파라미터를 갱신했습니다. 성공 응답 예시 이름을 COMMON_200으로 변경했습니다.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• Musereview/BE#180: 동일한 AuthController의 Swagger 문서와 인증 응답 예시를 수정합니다.
• Musereview/BE#204: 다른 도메인의 컨트롤러에서 Swagger 문구와 형식을 수정합니다.

Poem

OAuth 길은 간결해지고
토큰 예시는 둥지를 찾고
COMMON_200은 한곳에 모여
만료 시간도 빠짐없이 빛난다
인증 문서, 이제 길을 잃지 않네 ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	제목은 auth 도메인의 API 설명과 응답 설명을 수정한 주요 변경 내용을 직접적으로 요약합니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch refactor/#200-auth-description

---

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.}

[coderabbitai]

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/auth/controller/AuthController.java`:
- Around line 92-93: Update the `@Parameter` descriptions for redirectUri in both
startOAuthLogin and oAuthCallback to state that either backend-allowed or
frontend-allowed OAuth redirect URIs are accepted, matching
isBackendAllowedRedirectUri(...) and isFrontendAllowedRedirectUri(...).

🪄 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: f81bab23-b853-4cb2-a89b-0ffd3f17596f

📥 Commits

Reviewing files that changed from the base of the PR and between 92f647b and eaad057.

📒 Files selected for processing (1)

• src/main/java/com/mr/domain/auth/controller/AuthController.java

[rkdehdrbs7885-oss]

응답까지 신경 쓰신 부분이 좋은 것 같습니다! 수고하셨습니다!

[on1yoneprivate]

수고하셨습니다! 코드래빗 리뷰 참고해서 수정하면 좋을 것 같아요~!