Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ 프로필 위젯 관련 API 구현 #30

Merged
merged 5 commits into from
Nov 3, 2024
Merged

Conversation

waterfogSW
Copy link
Member

@waterfogSW waterfogSW commented Nov 3, 2024

Summary by CodeRabbit

  • 새로운 기능
    • 사용자 프로필 위젯을 추가 및 수정할 수 있는 새로운 엔드포인트 /users/profileWidgets가 추가되었습니다.
    • 사용자 프로필 응답에 사용자별 프로필 위젯 정보가 포함되도록 GetMyUserInfoResponse 스키마가 업데이트되었습니다.
    • 프로필 위젯 관리에 필요한 새로운 요청 및 응답 스키마가 도입되었습니다.

Copy link

coderabbitai bot commented Nov 3, 2024

Warning

Rate limit exceeded

@waterfogSW has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 4 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b7d77e2 and 98164aa.

Walkthrough

이 변경 사항은 openapi.yaml 파일에 여러 가지 수정을 도입하여 새로운 엔드포인트와 기존 스키마를 업데이트합니다. /users/profileWidgets라는 새로운 엔드포인트가 추가되어 프로필 위젯을 추가하고 수정하는 PUT 작업을 지원합니다. 이 엔드포인트는 인증을 위해 Bearer 토큰을 요구하며, 요청 본문은 PutProfileWidgetRequest 스키마로 정의됩니다. 성공적인 작업에 대한 응답은 PutProfileWidgetResponse 스키마로 정의됩니다. 또한, GetMyUserInfoResponse 스키마가 업데이트되어 사용자별 프로필 위젯 정보를 포함하는 profileWidgets 속성이 추가되었습니다.

Changes

파일 변경 요약
openapi.yaml - 새로운 엔드포인트 추가: PUT /users/profileWidgets
- 새로운 스키마 추가: PutProfileWidgetRequest, PutProfileWidgetResponse, ProfileWidget, ProfileWidgetType
- 기존 스키마 업데이트: GetMyUserInfoResponseprofileWidgets 속성 추가

Poem

🐇 새로운 위젯이 생겼어요,
프로필 꾸미기 즐거워요!
PUT 요청으로 추가하고,
내 정보가 풍성해지죠.
토큰을 챙기고,
위젯과 함께 춤춰요! 🎉


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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (1)
openapi.yaml (1)

839-853: ProfileWidgetType에 대한 설명이 부족합니다.

각 위젯 타입에 대한 구체적인 설명이 누락되어 있어, API 사용자가 각 타입의 용도를 정확히 이해하기 어렵습니다.

다음과 같이 각 타입에 대한 구체적인 설명을 추가하는 것을 제안합니다:

    ProfileWidgetType:
      type: string
      enum: [
        HOBBY,
        STYLE,
        BODY_TYPE,
        MUSIC,
        DRAMA_MOVIE,
        BOOK,
        MBTI,
        RELIGION,
        SMOKING,
        DRINKING,
      ]
-     description: 프로필 위젯 타입
+     description: |
+       프로필 위젯 타입:
+       * HOBBY - 취미 활동
+       * STYLE - 패션/스타일
+       * BODY_TYPE - 체형
+       * MUSIC - 좋아하는 음악
+       * DRAMA_MOVIE - 좋아하는 드라마/영화
+       * BOOK - 좋아하는 책
+       * MBTI - MBTI 성격 유형
+       * RELIGION - 종교
+       * SMOKING - 흡연 여부
+       * DRINKING - 음주 선호도
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f81da79 and b7d77e2.

📒 Files selected for processing (1)
  • openapi.yaml (3 hunks)

openapi.yaml Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
@waterfogSW waterfogSW merged commit 1ec369e into main Nov 3, 2024
3 checks passed
@waterfogSW waterfogSW deleted the feat/profile-widget branch November 3, 2024 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants