🩹 GetMyUserInfoResponse - display 필드 추가

[waterfogSW]

Summary by CodeRabbit

• 새로운 기능
  • 사용자 프로필 정보를 더 상세하게 표현하는 UserProfileDisplayInfo 스키마 추가.
  • 직업 및 회사에 대한 정보를 제공하는 JobOccupationDisplayInfo 및 CompanyDisplayInfo 스키마 추가.
  • 위치 정보를 위한 LocationDisplayInfo 스키마 추가.
• 변경 사항
  • 사용자 정보 응답 스키마에서 프로필 참조가 새로운 스키마로 업데이트됨.

[coderabbitai]

Walkthrough

이 변경 사항은 3days API의 OpenAPI 사양에 여러 가지 수정을 도입합니다. 새로운 스키마 UserProfileDisplayInfo가 추가되어 GetMyUserInfoResponse와 UpdateMyUserInfoResponse 스키마에서 이전의 UserProfile 참조를 대체합니다. 이 스키마는 company와 locations와 같은 추가 속성을 포함하여 사용자 프로필 정보의 세부 사항을 향상시킵니다. 또한, JobOccupationDisplayInfo 및 CompanyDisplayInfo 스키마가 도입되어 직업 및 회사에 대한 구조화된 정보를 제공합니다.

Changes

파일 경로	변경 요약
openapi.yaml	- 새로운 스키마 UserProfileDisplayInfo, CompanyDisplayInfo, JobOccupationDisplayInfo, LocationDisplayInfo 추가 - GetMyUserInfoResponse 및 UpdateMyUserInfoResponse에서 UserProfile 참조를 UserProfileDisplayInfo로 업데이트

Possibly related PRs

• ✨ 직업 API 추가 및 태그 분류 수정 #11: UserProfile 스키마의 변경 사항은 직업 식별자와 관련된 속성 업데이트를 포함하며, 이는 본 PR에서 도입된 JobOccupationDisplayInfo 스키마와 관련이 있을 수 있습니다.
• ✨ 파트너 직업군 복수선택 가능하도록 변경 #18: 이 PR은 UserDesiredPartner 스키마를 수정하여 여러 직업 분류를 허용하며, 이는 본 PR의 새로운 직업 관련 스키마와 연결됩니다.
• ✨ 직업군 수정 #20: 이 PR의 JobOccupations 스키마 업데이트는 직업 범주 변경을 반영하며, 이는 본 PR에서 도입된 JobOccupationDisplayInfo 스키마와 관련이 있을 수 있습니다.
• ✨ 유저 프로필 수정 api spec정의 #31: 이 PR에서 UpdateMyUserInfoRequest 및 UpdateMyUserInfoResponse 스키마의 추가는 본 PR의 사용자 프로필 스키마 업데이트와 관련이 있으며, 특히 새로운 UserProfileDisplayInfo 참조와 관련이 있습니다.

Suggested labels

fix

Suggested reviewers

• dojinyou
• moondev03
• jisu15-kim

🐇 새로운 스키마가 왔어요,
사용자 정보가 더 풍부해져요!
직업과 회사도 함께해,
프로필이 더욱 빛나요!
API가 한층 더 똑똑해,
모두가 기뻐할 거예요! ✨

---

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)

780-795: 예제 추가 제안

다른 스키마들처럼 CompanyDisplayInfo에도 예제를 추가하면 API 문서의 일관성과 이해도를 높일 수 있습니다.

       required:
         - id
         - display
+      example:
+        id: "0191cd0e-a061-7213-b39e-51274c1e7c71"
+        display: "CodeRabbit Inc."

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between aba707b and 01f2e63.

📒 Files selected for processing (1)

• openapi.yaml (2 hunks)

🔇 Additional comments (4)

openapi.yaml (4)

756-779: 구조가 잘 설계되었습니다!

UserProfileDisplayInfo 스키마가 다음과 같은 장점을 가지고 있습니다:

• 필수 필드가 명확하게 정의되어 있습니다
• 각 속성에 대한 설명이 명확합니다
• 기존 UserProfile과의 하위 호환성을 유지하면서 표시용 필드를 추가했습니다

---

796-810: 잘 구현되었습니다!

JobOccupationDisplayInfo 스키마가 기존 JobOccupation enum을 잘 활용하면서 표시용 필드를 추가했고, 예제도 포함되어 있습니다.

---

811-827: 잘 구현되었습니다!

LocationDisplayInfo 스키마가 다른 display 정보 스키마들과 일관된 구조를 가지고 있으며, 예제도 포함되어 있습니다.

---

671-671: ⚠️ Potential issue

응답 스키마 간 일관성 검토 필요

GetMyUserInfoResponse는 UserProfileDisplayInfo를 사용하도록 변경되었지만, UpdateMyUserInfoResponse는 여전히 UserProfile을 참조하고 있습니다. 두 응답의 일관성을 위해 UpdateMyUserInfoResponse도 동일하게 변경이 필요해 보입니다.