✨Feature/#24: 4.3 온기 간단 정보 조회 API 구현

[dongkyeomjang]

Related issue 🛠

closed #26

어떤 변경사항이 있었나요?

• 🐞 BugFix Something isn't working
• 💻 CrossBrowsing Browser compatibility
• 🌏 Deploy Deploy
• 🎨 Design Markup & styling
• 📃 Docs Documentation writing and editing (README.md, etc.)
• ✨ Feature Feature
• 🔨 Refactor Code refactoring
• ⚙️ Setting Development environment setup
• ✅ Test Test related (storybook, jest, etc.)

CheckPoint ✅

PR이 다음 요구 사항을 충족하는지 확인하세요.

• PR 컨벤션에 맞게 작성했습니다. (필수)
• Docker Container 환경으로 변경 사항에 대한 테스트를 했습니다.(버그 수정/기능에 대한 테스트). (필수)
• Feature의 경우, API 문서 업데이트를 완료했습니다. (선택)
• BugFix의 경우, 버그의 원인을 파악하였습니다. (선택)

Work Description ✏️

• 4.3 온기 간단 정보 조회 API 구현

Uncompleted Tasks 😅

N/A

To Reviewers 📢

Summary by CodeRabbit

• New Features

  • Introduced a new API endpoint for retrieving brief information about "온기" (Onjung) via GET /api/v1/onjungs/briefs.
  • Added functionality to calculate total amounts related to "Onjung" instances.

• Bug Fixes

  • Enhanced error handling for user retrieval in the new service.

• Documentation

  • Updated API documentation to include the new endpoint and its usage.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new API endpoint has been introduced to retrieve brief information about "온기" (Onjung) in the OnjungControllerHttpRequest. This change includes the addition of a new method in the OnjungQueryV1Controller to handle requests for this data, along with a new service class and response DTO to encapsulate the functionality. The modifications do not alter existing features but expand the API's capabilities.

Changes

File	Change Summary
http/onjung/OnjungControllerHttpRequest.http	Added new endpoint: GET {{host_url}}/api/v1/onjungs/briefs for retrieving brief information.
src/main/java/com/daon/onjung/onjung/application/controller/query/OnjungQueryV1Controller.java	Added method: public ResponseDto<ReadOnjungBriefResponseDto> readOnjungBrief(@AccountID UUID accountId). Added private field: private final ReadOnjungBriefUseCase readOnjungBriefUseCase.
src/main/java/com/daon/onjung/onjung/application/dto/response/ReadOnjungBriefResponseDto.java	Added new class: ReadOnjungBriefResponseDto with fields totalOnjungCount and totalOnjungAmount.
src/main/java/com/daon/onjung/onjung/application/service/ReadOnjungBriefService.java	Added service class: ReadOnjungBriefService implementing ReadOnjungBriefUseCase with method public ReadOnjungBriefResponseDto execute(UUID accountId).
src/main/java/com/daon/onjung/onjung/application/usecase/ReadOnjungBriefUseCase.java	Added new interface: ReadOnjungBriefUseCase with method ReadOnjungBriefResponseDto execute(UUID accountId).
src/main/java/com/daon/onjung/onjung/domain/service/OnjungService.java	Added method: public Integer calculateTotalOnjungAmount(Onjung onjung) for computing total amount.

Assessment against linked issues

Objective	Addressed	Explanation
Implement Onjung brief information retrieval API (26)	✅

Possibly related issues

• ✨ Feature - 4.1 전체 온기 통계 조회 API 구현 #24: The changes could relate to the overall statistics retrieval API as they both deal with "온기" (Onjung) data, potentially enhancing the statistical overview.
• ✨ Feature - 4.6 온기 공유 API 구현 #29: The implementation of the Onjung sharing API may benefit from the new brief retrieval feature, as it could provide context or data needed for sharing functionalities.

Poem

In the fields where 온기 grows,
A new path for knowledge flows.
With a token held, you can see,
Briefs of Onjung, wild and free!
Hop along, let data play,
In our API's bright new day! 🐇✨

Warning

Rate limit exceeded

@dongkyeomjang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 18 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 89150f8 and 70b5466.

---

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.

[bianbbc87]

LGTM