[Docs] Swagger 문서 누락/오류 수정

[leegwichan]

✨ 개요

• Swagger 문서에 누락되거나 잘못된 부분 수정
  • 스토리 목록 조회 API의 누락되었던 size 쿼리 파라미터 추가
  • 음식점 목록 조회 API에 category 쿼리 파라미터 중 잘못 명시된 값 수정

🧾 관련 이슈

없음

🔍 참고 사항 (선택)

Summary by CodeRabbit

• Documentation
  • "GetStores" 엔드포인트의 "category" 쿼리 파라미터 설명에서 카테고리 옵션의 순서와 형식을 "카페/디저트"로 수정하였습니다.
  • "GetStories" 엔드포인트에 "size" 쿼리 파라미터 설명을 추가하여, 기본값(5) 및 허용 범위(1~50)를 명확히 안내합니다.

[coderabbitai]

Walkthrough

API 문서 테스트 코드가 일부 수정되었습니다. Store 엔드포인트의 카테고리 쿼리 파라미터 설명이 변경되었고, Story 엔드포인트에는 size 쿼리 파라미터에 대한 설명이 새로 추가되었습니다. 코드의 논리나 기능에는 변화가 없습니다.

Changes

Cohort / File(s)	Change Summary
Store API 문서 쿼리 파라미터 설명 수정 src/test/java/eatda/document/store/StoreDocumentTest.java	"category" 쿼리 파라미터 설명에서 옵션 순서와 포맷이 "디저트/카페"에서 "카페/디저트"로 변경됨.
Story API 문서 쿼리 파라미터 추가 src/test/java/eatda/document/story/StoryDocumentTest.java	"size" 쿼리 파라미터 설명이 추가되어, 기본값과 허용 범위 등 상세 설명이 문서화됨.

Sequence Diagram(s)

(생략: 변경 사항이 문서화에 한정되어 있어 시퀀스 다이어그램이 필요하지 않습니다.)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~6 minutes

Suggested labels

docs

Suggested reviewers

• lvalentine6

Poem

🍰🐇
문서에 살짝 손길을 더해,
카페와 디저트, 순서 바꿔 새로워졌네.
이야기 리스트, 사이즈도 명확히 밝혀
리뷰어의 발걸음 가볍게 하네!
작은 변화, 큰 미소로 남아
토끼도 기쁘게 깡충깡충 뛰어요.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e9f5cd3 and 28fbd8b.

📒 Files selected for processing (2)

• src/test/java/eatda/document/store/StoreDocumentTest.java (1 hunks)
• src/test/java/eatda/document/story/StoryDocumentTest.java (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

src/test/java/eatda/document/store/StoreDocumentTest.java (1)

Learnt from: leegwichan
PR: #90
File: src/main/java/eatda/service/story/StoryService.java:93-93
Timestamp: 2025-07-20T03:52:23.831Z
Learning: StoreCategory enum has @Getter annotation with a categoryName field, so getCategoryName() method is automatically generated by Lombok at compile time and won't appear in source code searches.

🔇 Additional comments (3)

src/test/java/eatda/document/store/StoreDocumentTest.java (1)

106-106: 문서 개선이 적절합니다.

카테고리 파라미터 설명에서 "디저트/카페"를 "카페/디저트"로 수정한 것이 실제 비즈니스 요구사항이나 enum 순서와 일치하도록 개선된 것으로 보입니다.

src/test/java/eatda/document/story/StoryDocumentTest.java (2)

9-9: 필요한 import가 적절히 추가되었습니다.

parameterWithName import 추가로 쿼리 파라미터 문서화를 위한 준비가 완료되었습니다.

---

121-124: 누락된 size 파라미터 문서화가 완벽합니다.

스토리 목록 조회 API에 누락되었던 size 쿼리 파라미터에 대한 상세한 문서가 추가되었습니다. 기본값(5), 최소값(1), 최대값(50) 정보와 함께 optional 표시도 적절히 포함되어 있어 API 사용자에게 명확한 가이드를 제공합니다.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/fix-docs

---

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

• 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.
  • 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 generate unit tests to generate unit tests for 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.

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[lvalentine6]

LGTM!!

[github-actions]

🎉 This PR is included in version 1.4.0-develop.37 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀