✨ 유저 이상형 프로필 수정 UseCase 개발

[waterfogSW]

Summary by CodeRabbit

• 신규 기능
  • 사용자가 원하는 파트너 정보를 업데이트할 수 있는 새로운 API 엔드포인트 /users/my/desiredPartner 추가.
  • 요청 및 응답 구조를 정의하는 새로운 스키마 UpdateUserDesiredPartnerRequest 및 UpdateUserDesiredPartnerResponse 추가.

[coderabbitai]

Walkthrough

이 변경 사항은 openapi.yaml 파일에 여러 수정을 도입하여 사용자 관련 기능에 대한 API 사양을 향상시킵니다. 새로운 엔드포인트 /users/my/desiredPartner가 추가되어 사용자가 원하는 파트너 정보를 업데이트할 수 있습니다. 이 엔드포인트는 UpdateUserDesiredPartnerRequest 스키마에 정의된 요청 본문을 지원하며, UpdateUserDesiredPartnerResponse 스키마에 따라 구조화된 응답을 반환합니다. 기존의 사용자 관련 엔드포인트는 변경되지 않지만, 이제 새로운 기능으로 보완됩니다.

Changes

파일	변경 요약
openapi.yaml	- /users/my/desiredPartner에 대한 PUT 메서드 추가 - UpdateUserDesiredPartnerRequest 및 UpdateUserDesiredPartnerResponse 스키마 추가

Possibly related PRs

• ✨ 파트너 직업군 복수선택 가능하도록 변경 #18: UserDesiredPartner 스키마의 변경으로 여러 직업을 허용하며, 이는 새로운 파트너 정보 업데이트 엔드포인트와 관련이 있습니다.
• ✨ 같은회사 원하는지 여부 추가 및 회사 입력 non-required 수정 #28: UserDesiredPartner 스키마에 wannaSameCompany 속성이 추가되어 사용자 선호 관리와 관련이 있습니다.
• ✨ 유저 프로필 수정 api spec정의 #31: UpdateMyUserInfoRequest 스키마의 추가는 사용자 프로필 관리를 포함하여 새로운 파트너 정보 업데이트 엔드포인트와 보완 관계에 있습니다.
• ✨ 프로필 수정시 같은 회사 소개 여부 추가 #34: UserDesiredPartner 스키마에 allowSameCompany 속성이 추가되어 새로운 파트너 정보 업데이트 기능과 직접적으로 관련이 있습니다.
• ✨ 프로필 수정 API 변경 #35: UpdateMyUserInfoRequest 스키마의 업데이트는 사용자 프로필 관리의 향상을 포함하여 주요 PR과 관련이 있습니다.

Suggested labels

fix

Suggested reviewers

• dojinyou
• moondev03
• jisu15-kim

🐰 새로운 기능이 생겼어요,
원하는 파트너를 찾는 길이 열렸죠!
요청과 응답이 정리되어,
사용자 프로필이 더 풍성해졌어요.
함께 꿈꾸는 사랑의 파트너,
이제는 업데이트가 쉬워졌어요! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f34e521 and 7dfd936.

📒 Files selected for processing (1)

• openapi.yaml (2 hunks)

🔇 Additional comments (3)

openapi.yaml (3)

185-212: LGTM! API 엔드포인트가 잘 정의되어 있습니다.

RESTful 규칙을 잘 따르고 있으며, 보안 및 에러 응답이 적절하게 정의되어 있습니다.

---

766-780: 필수 필드에 대한 유효성 검증이 필요합니다.

birthYearRange, jobOccupations, preferDistance 필드에 대한 추가적인 유효성 검증이 필요해 보입니다:

• birthYearRange: 시작년도가 종료년도보다 작아야 합니다.
• jobOccupations: 최소/최대 선택 가능한 직군 수를 제한해야 합니다.
• preferDistance: 이미 enum으로 잘 정의되어 있습니다.

---

781-788: 응답 스키마가 잘 정의되어 있습니다.

UserDesiredPartner 타입을 재사용하여 일관성 있게 정의되어 있습니다.

---

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: 1

🧹 Outside diff range and nitpick comments (1)

openapi.yaml (1)

781-788: 응답 스키마의 들여쓰기가 일관성이 없습니다.

응답 스키마의 들여쓰기가 다른 스키마들과 일관성이 없습니다.

다음과 같이 수정하는 것을 제안드립니다:

-    UpdateUserDesiredPartnerResponse:
-        type: object
-        properties:
-          desiredPartner:
-            $ref: '#/components/schemas/UserDesiredPartner'
-        required:
-            - desiredPartner
+    UpdateUserDesiredPartnerResponse:
+      type: object
+      properties:
+        desiredPartner:
+          $ref: '#/components/schemas/UserDesiredPartner'
+      required:
+        - desiredPartner

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fc5b0be and f34e521.

📒 Files selected for processing (1)

• openapi.yaml (2 hunks)

🔇 Additional comments (1)

openapi.yaml (1)

185-212: 엔드포인트 정의가 잘 구성되어 있습니다.

API 엔드포인트가 RESTful 규칙을 잘 따르고 있으며, 보안 및 응답 정의가 체계적으로 되어 있습니다.