Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Swagger 문서에서 DB에 존재하지 않는 예시 키워드들을 정리/대체하여 API 문서의 신뢰도를 높이려는 PR입니다.
Changes:
UserProfileUpdateRequestDto에서 나이 관련 스키마/예시를 제거하고 키워드 예시를 DB 기준으로 대체- 온보딩(CreateProfileDto) 선택 키워드 예시를 DB 기준으로 대체
package-lock.json루트 패키지에engines메타데이터가 추가됨
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/modules/user/dtos/user-profile-update-request.dto.ts | 프로필 수정 요청 DTO의 Swagger 예시/필드 정리 |
| src/modules/onboarding/dtos/onboarding.dto.ts | 온보딩 DTO의 Swagger 예시 키워드 수정 |
| package-lock.json | lockfile 루트에 engines 정보 추가 |
Comments suppressed due to low confidence (1)
src/modules/user/dtos/user-profile-update-request.dto.ts:27
age필드가 DTO에서 제거되면(현재 전역 ValidationPipe가 whitelist=true + forbidNonWhitelisted=true)/users/me업데이트 요청에age가 포함될 때 422로 거절됩니다. 반면 서비스/리포지토리는 여전히payload.age로 나이 업데이트를 처리하고 있어 API 동작/문서가 불일치합니다. 나이 업데이트를 지원해야 한다면 DTO에age?: number를 다시 추가하고 숫자 타입에 맞는 validator로 검증해 주세요. 반대로 나이를 더 이상 수정 불가로 만들 의도라면 서비스/리포지토리의 age 업데이트 로직 및 관련 Swagger 응답/문서를 함께 정리해야 합니다.
nickname?: string;
@ApiPropertyOptional({ example: 'F', enum: Sex })
@IsOptional()
@IsEnum(Sex)
gender?: Sex;
@ApiPropertyOptional({ example: 53, description: '만 나이' })
@IsOptional()
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
38
to
41
| @ApiProperty({ | ||
| example: ['뜨개질', '산책', '영화'], | ||
| example: ['등산', '영화감상' ], | ||
| description: '선택한 키워드 배열', | ||
| }) |
There was a problem hiding this comment.
Swagger example 배열에 불필요한 공백(['등산', '영화감상' ],)이 들어가 있어 Prettier/린트 규칙과 다를 수 있습니다. 공백을 제거해 포맷을 일관되게 맞춰 주세요.
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
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.
주요 변경사항