✨ 파트너 직업군 복수선택 가능하도록 변경

[waterfogSW]

Summary by CodeRabbit

• 신규 기능
  • SMS 인증 코드 확인 및 사용자 등록을 위한 새로운 API 경로 추가.
  • 사용자 인증 및 토큰 갱신을 위한 새로운 엔드포인트 추가.
  • 위치 및 회사 검색 기능 추가.
  • 직업 검색을 위한 API 경로 추가.
• 스키마 업데이트
  • 사용자 파트너 정보 구조 변경: 직업 분류를 배열로 허용.
  • 오류 응답 스키마 표준화.

[coderabbitai]

Walkthrough

이 변경 사항은 사용자 인증 및 등록을 위한 API 사양을 중심으로 여러 수정 사항을 포함하고 있습니다. 새로운 사용자 및 기존 사용자 인증 코드 검증 경로가 정의되었으며, 사용자 등록 및 토큰 갱신을 위한 엔드포인트가 추가되었습니다. 위치 및 회사 조회, 직업 검색을 위한 경로도 명시되었으며, 데이터 구조와 응답 스키마가 조정되었습니다. 오류 응답 스키마는 일관성을 위해 표준화되었습니다.

Changes

파일 경로

변경 요약

openapi.yaml

- /auth/codes 경로 추가 (SMS 인증 요청) - /auth/codes/{authCodeId}/existingUser 경로 추가 (기존 사용자 인증) - /auth/codes/{authCodeId}/newUser 경로 추가 (신규 사용자 인증) - /users 경로 추가 (사용자 등록) - /auth/token/refresh 경로 추가 (토큰 갱신) - /locations 경로 추가 (위치 목록 조회) - /companies 경로 추가 (회사 검색) - /companies/{companyId} 경로 추가 (회사 세부정보 조회) - /jobs 경로 추가 (직업 검색) - UserDesiredPartner 스키마 업데이트 (단일 속성에서 배열로 변경) - JobOccupations 스키마 추가 (문자열 배열로 정의) - Gender 및 OSType 스키마는 변경 없음 - 오류 응답 스키마 표준화

Possibly related PRs

• ✨ 직업 API 추가 및 태그 분류 수정 #11: 사용자 인증 및 직업 검색 엔드포인트에 대한 수정 사항을 포함하여, 사용자 검증 및 직업 검색 기능과 직접적으로 관련이 있습니다.
• 🩹 Response 응답 여러개일 경우 코드 생성 문제 수정 및 리펙터링 #12: 새로운 auth 태그를 도입하고 /users 엔드포인트를 업데이트하여 사용자 등록 및 인증에 대한 주요 PR과 일치합니다.
• ♻️ API 스펙 리펙터링 #13: 인증 엔드포인트를 리팩토링하여 /auth 경로 아래로 통합하였으며, 이는 사용자 인증 및 등록에 관한 주요 PR과 직접적으로 관련이 있습니다.
• ✨ 나이는 상관 없어요 반영 #17: 신규 및 기존 사용자의 SMS 인증 코드 검증 및 사용자 등록을 위한 새로운 엔드포인트를 추가하여 주요 PR의 핵심 요소와 관련이 있습니다.

Suggested labels

fix

Suggested reviewers

• dojinyou
• moondev03
• jisu15-kim

🐰 새로운 길을 찾아,
인증의 문을 열어,
사용자 등록도 쉽게,
직업도 찾을 수 있어!
모두 함께 나아가,
더 나은 세상 만들자,
우리 모두의 꿈을 위해! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

openapi.yaml (1)

702-720: JobOccupations 스키마가 적절히 정의되었습니다.

JobOccupations 스키마를 문자열 배열로 정의하고 구체적인 직업군 목록을 제공한 것은 좋은 접근입니다. 이는 사용자에게 다양한 선택지를 제공하며, 데이터의 일관성을 유지하는 데 도움이 됩니다.

한 가지 제안사항이 있습니다:

직업군 목록에 "STUDENT" 항목을 추가하는 것을 고려해보세요. 많은 데이팅 앱 사용자가 학생일 수 있으며, 이는 "OTHER"와는 구분되는 중요한 카테고리입니다.

enum: [
  BUSINESS_ADMIN,
  FINANCE_INSURANCE,
  RESEARCH_ENGINEERING,
  EDUCATION,
  LAW,
  POLICE_MILITARY,
  IT_SOFTWARE,
  DESIGN_ART,
  SPORTS,
  HEALTHCARE,
  FREELANCER,
+ STUDENT,
  OTHER
]

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 397d8da and c315a1f.

📒 Files selected for processing (1)

• openapi.yaml (2 hunks)

🔇 Additional comments (3)

openapi.yaml (3)

548-553: 변경사항이 PR 목표와 일치합니다.

UserDesiredPartner 스키마에서 jobOccupation을 jobOccupations로 변경한 것은 적절합니다. 이 변경으로 사용자가 파트너의 직업군을 여러 개 선택할 수 있게 되었습니다. 이는 PR의 목표인 "파트너 직업군 복수선택 가능하도록 변경"과 정확히 일치합니다.

---

Line range hint 1-720: 관련 스키마들이 변경사항과 일관성을 유지하고 있습니다.

UserDesiredPartner와 JobOccupations 스키마의 변경사항이 파일의 다른 부분과 잘 통합되어 있습니다. 특히 RegisterUserRequest 스키마가 수정된 UserDesiredPartner를 자동으로 포함하고 있어 추가적인 변경이 필요하지 않습니다.

이러한 일관성은 API의 안정성을 유지하는 데 도움이 됩니다. 좋은 작업입니다!

---

Line range hint 1-720: 전반적인 변경사항이 잘 구현되었습니다.

이번 PR의 변경사항들은 다음과 같은 점에서 훌륭합니다:

1. PR의 목표인 "파트너 직업군 복수선택 가능하도록 변경"을 정확히 구현했습니다.
2. UserDesiredPartner와 JobOccupations 스키마의 변경이 API의 유연성을 향상시켰습니다.
3. 기존 API 구조를 해치지 않으면서 새로운 기능을 추가했습니다.
4. 변경사항들이 서로 일관성을 유지하고 있어 안정적입니다.

이러한 변경으로 사용자들은 더 다양한 직업군의 파트너를 선택할 수 있게 되어 매칭의 질이 향상될 것으로 예상됩니다. 전체적으로 잘 구현된 PR입니다.