[Refactor/#248] DTO Swagger ApiProperty 정리 및 Prettier 포맷 적용 - #249
Merged
Conversation
3 tasks
Walkthrough일정 Swagger 문서를 전용 파일로 분리하고 컨트롤러에 적용했습니다. 일기 수정 요청에 이미지 배열 필드를 추가했습니다. AI·통계 DTO와 여러 서비스, 컨트롤러의 코드 형식을 정리했습니다. Changes일정 Swagger 문서 분리
일기 DTO 및 코드 형식 정리
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/schedules/schedule.swagger.ts (1)
550-586: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value
UpdateScheduleSwagger에description을 추가하세요.다른 엔드포인트 데코레이터는
ApiOperation에summary와description을 함께 제공합니다.UpdateScheduleSwagger는summary만 제공합니다. 이 엔드포인트는scope값에 따라 응답 형태가 달라집니다. 그 동작을description에 설명하면 문서 품질이 일관됩니다.♻️ 제안 변경
- ApiOperation({ summary: '일정 수정' }), + ApiOperation({ + summary: '일정 수정', + description: + '로그인한 사용자의 일정을 수정합니다. scope=SINGLE이면 선택한 일정만 수정하고, scope=ALL이면 동일한 반복 그룹 전체를 수정합니다. scope 값에 따라 응답 data 형태가 달라집니다.', + }),🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/schedules/schedule.swagger.ts` around lines 550 - 586, Update the ApiOperation configuration in UpdateScheduleSwagger to include a description explaining that the response varies according to the scope value, while preserving the existing summary and decorator behavior.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/diaries/diary.swagger.ts`:
- Around line 147-151: Resolve the mismatch between the PATCH schema in
UpdateDiarySwagger and the updateDiary flow: either implement dto.images
replacement, deletion, and persistence according to the existing diary image
rules, or remove images from the PATCH Swagger schema if image updates are
unsupported. Verify the PATCH connection in the diary controller and keep the
documented API aligned with updateDiary behavior.
---
Nitpick comments:
In `@src/schedules/schedule.swagger.ts`:
- Around line 550-586: Update the ApiOperation configuration in
UpdateScheduleSwagger to include a description explaining that the response
varies according to the scope value, while preserving the existing summary and
decorator behavior.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 7aa5fdff-559f-4c9b-82de-9f798ec7111e
📒 Files selected for processing (21)
src/ai/dto/ai-answer.dto.tssrc/ai/dto/ai-diary-question.dto.tssrc/ai/dto/ai-question.dto.tssrc/ai/dto/ai-recommend.dto.tssrc/ai/entities/ai-recommend.entity.tssrc/ai/services/ai-question.service.tssrc/ai/services/ai-recommend.service.tssrc/alarms/alarms.swagger.tssrc/auth/entities/email-verification.entity.tssrc/categories/category.controller.tssrc/categories/entities/category.entity.tssrc/diaries/diary.dto.tssrc/diaries/diary.module.tssrc/diaries/diary.service.tssrc/diaries/diary.swagger.tssrc/global/utills/date.utill.tssrc/schedules/entities/schedule.entity.tssrc/schedules/schedule.controller.tssrc/schedules/schedule.swagger.tssrc/stats/stats.controller.tssrc/stats/stats.dto.ts
💤 Files with no reviewable changes (10)
- src/ai/dto/ai-question.dto.ts
- src/ai/dto/ai-diary-question.dto.ts
- src/ai/dto/ai-answer.dto.ts
- src/diaries/diary.module.ts
- src/diaries/diary.dto.ts
- src/ai/dto/ai-recommend.dto.ts
- src/auth/entities/email-verification.entity.ts
- src/schedules/entities/schedule.entity.ts
- src/stats/stats.dto.ts
- src/categories/entities/category.entity.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📌 관련 이슈번호
(Closes 키워드가 있어야 PR이 머지되었을 때 이슈가 자동으로 닫힌다)
📌 PR 유형
어떤 변경 사항이 있나요?
📌 PR 요약
DTO Swagger ApiProperty 정리 및 Prettier 포맷 적용
📌 작업 세부 내용
📸 스크린샷 (선택)
🔗 참고 자료