Skip to content

feat(Order,Reservation): 주문 조회 응답 데이터 개선 및 대기열 CRUD 구현#142

Merged
HyemIin merged 1 commit into
developfrom
feature/#130_관리자예약호출로직
Jul 22, 2025

Hidden character warning

The head ref may contain hidden characters: "feature/#130_\uad00\ub9ac\uc790\uc608\uc57d\ud638\ucd9c\ub85c\uc9c1"
Merged

feat(Order,Reservation): 주문 조회 응답 데이터 개선 및 대기열 CRUD 구현#142
HyemIin merged 1 commit into
developfrom
feature/#130_관리자예약호출로직

Conversation

@HyemIin

@HyemIin HyemIin commented Jul 22, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

작업 요약

Issue Link

문제점 및 어려움

해결 방안

Reference

Summary by CodeRabbit

  • Documentation
    • API 문서에 각 응답 DTO 클래스와 필드에 대한 설명 및 예시 값이 추가되어, Swagger를 통한 API 문서가 더욱 명확해졌습니다.

@HyemIin
feat(Order,Reservation): 주문 조회 응답 데이터 개선 및 대기열 CRUD 구현
f139909 
- order 조회 응답 데이터 구조 변경
- 관리자 측 대기열 조회,변경 로직 구현
@HyemIin HyemIin self-assigned this Jul 22, 2025
@coderabbitai

coderabbitai Bot commented Jul 22, 2025 •
edited
Loading

Copy link
Copy Markdown

Walkthrough

두 DTO 클래스(CallGetResponseDto, ReservationGetResponseDto)에 Swagger OpenAPI의 @Schema 어노테이션이 추가되어, 각 클래스와 필드에 대한 설명 및 예시 값이 문서화되었습니다. 클래스 구조나 로직에는 변경이 없으며, 문서화 목적의 어노테이션만이 반영되었습니다.

Changes

파일 경로 변경 요약
.../reservation/dto/CallGetResponseDto.java
.../reservation/dto/ReservationGetResponseDto.java		 각 클래스 및 모든 필드에 Swagger @Schema 어노테이션 추가

Estimated code review effort

1 (~2 minutes)

Suggested reviewers

  • Jjiggu
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@github-actions github-actions Bot requested a review from Jjiggu July 22, 2025 09:59
coderabbitai[bot]
coderabbitai Bot reviewed Jul 22, 2025
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (7)
nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/reservation/dto/ReservationGetResponseDto.java (3)

19-20: storeId 설명 용어 통일 필요

이 DTO에서는 “매장 ID”로 기술했지만, CallGetResponseDto 쪽은 “가게 ID”로 표기하고 있습니다. 스웨거 문서를 읽는 소비자에게 혼란을 줄 수 있으니 동일한 용어(매장/가게)로 맞춰주세요.

25-26: 날짜·시간 예시 값에서 마이크로초·타임존 표기 고려

2025-07-22T14:45:09.492253 형태는 마이크로초까지 포함돼 가독성이 떨어지고, 타임존 정보가 없어 클라이언트가 해석하기 어렵습니다.

-	@Schema(description = "예약 요청 시각", example = "2025-07-22T14:45:09.492253")
+	@Schema(description = "예약 요청 시각(ISO-8601)", example = "2025-07-22T14:45:09Z")

28-29: status 필드에 Enum 값 명시

ReservationStatus(가정) enum을 그대로 노출하는 필드라면 allowableValues 또는 enumAsRef = true 옵션을 통해 가능한 값 목록을 문서에 표시해 주는 편이 Swagger UI 가독성에 도움이 됩니다.

nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/reservation/dto/CallGetResponseDto.java (4)

18-20: storeId 설명 용어 통일 필요

여기서는 “가게 ID”로 돼 있으나, ReservationGetResponseDto에서는 “매장 ID”로 사용 중입니다. 하나로 통일하여 문서 일관성을 유지해주세요.

24-25: 날짜·시간 예시 값 개선 제안

타 DTO와 동일하게 마이크로초 제거 및 타임존 포함을 권장합니다.

-	@Schema(description = "예약 요청 시각", example = "2025-07-22T14:45:09.492253")
+	@Schema(description = "예약 요청 시각(ISO-8601)", example = "2025-07-22T14:45:09Z")

27-28: status 필드 Swagger enum 노출 권장

예약 상태가 enum이라면 @Schema(enumAsRef = true) 등을 통해 가능한 값을 Swagger 문서에 명확히 보여주세요.

30-31: partySize 설명 어휘 일관성

ReservationGetResponseDto에서는 “파티 인원”, 이쪽은 “파티 인원 수”로 다릅니다. 용어를 하나로 맞추는 편이 좋습니다.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 31863bb and f139909.

📒 Files selected for processing (2)
  • nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/reservation/dto/CallGetResponseDto.java (1 hunks)
  • nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/reservation/dto/ReservationGetResponseDto.java (1 hunks)

@HyemIin HyemIin merged commit 850b49c into develop Jul 22, 2025
2 checks passed
@HyemIin HyemIin deleted the feature/#130_관리자예약호출로직 branch July 22, 2025 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@Jjiggu Jjiggu Awaiting requested review from Jjiggu

Assignees

@HyemIin HyemIin

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@HyemIin