Conversation
There was a problem hiding this comment.
Code Review
This pull request improves the Swagger documentation for the files module by applying @ApiProperty decorators to entity classes and refactoring the FilesController to utilize $ref schemas with getSchemaPath. Feedback was provided to restore previously existing JSDoc descriptions by including them in the description property of the @ApiProperty decorators to maintain documentation clarity in the Swagger UI.
| @ApiProperty({ type: Number, example: 42 }) | ||
| fileCount: number; |
There was a problem hiding this comment.
기존에 존재하던 JSDoc 설명이 삭제되었습니다. Swagger UI에서도 해당 설명이 노출될 수 있도록 @ApiProperty의 description 속성을 사용하는 것이 좋습니다.
| @ApiProperty({ type: Number, example: 42 }) | |
| fileCount: number; | |
| @ApiProperty({ type: Number, example: 42, description: '재귀적으로 탐색한 파일 수' }) | |
| fileCount: number; |
| @ApiProperty({ type: Number, example: 5 }) | ||
| directoryCount: number; |
There was a problem hiding this comment.
기존에 존재하던 JSDoc 설명이 삭제되었습니다. Swagger UI에서도 해당 설명이 노출될 수 있도록 @ApiProperty의 description 속성을 사용하는 것이 좋습니다.
| @ApiProperty({ type: Number, example: 5 }) | |
| directoryCount: number; | |
| @ApiProperty({ type: Number, example: 5, description: '재귀적으로 탐색한 하위 디렉토리 수 (루트 제외)' }) | |
| directoryCount: number; |
| @ApiProperty({ type: Number, example: 44 }) | ||
| leafCount: number; |
There was a problem hiding this comment.
기존에 존재하던 JSDoc 설명이 삭제되었습니다. Swagger UI에서도 해당 설명이 노출될 수 있도록 @ApiProperty의 description 속성을 사용하는 것이 좋습니다.
| @ApiProperty({ type: Number, example: 44 }) | |
| leafCount: number; | |
| @ApiProperty({ type: Number, example: 44, description: '자식이 없는 leaf 노드 수 (파일 + 빈 디렉토리)' }) | |
| leafCount: number; |
| @ApiProperty({ type: Number, example: 10485760 }) | ||
| totalSize: number; |
There was a problem hiding this comment.
기존에 존재하던 JSDoc 설명이 삭제되었습니다. Swagger UI에서도 해당 설명이 노출될 수 있도록 @ApiProperty의 description 속성을 사용하는 것이 좋습니다.
| @ApiProperty({ type: Number, example: 10485760 }) | |
| totalSize: number; | |
| @ApiProperty({ type: Number, example: 10485760, description: '모든 파일 크기의 합계 (byte)' }) | |
| totalSize: number; |
| @ApiProperty({ type: Number, nullable: true, example: 123 }) | ||
| size: number | null; |
There was a problem hiding this comment.
기존에 존재하던 JSDoc 설명이 삭제되었습니다. Swagger UI에서도 해당 설명이 노출될 수 있도록 @ApiProperty의 description 속성을 사용하는 것이 좋습니다.
| @ApiProperty({ type: Number, nullable: true, example: 123 }) | |
| size: number | null; | |
| @ApiProperty({ type: Number, nullable: true, example: 123, description: 'byte' }) | |
| size: number | null; |
| @ApiProperty({ type: Number, nullable: true, example: 3 }) | ||
| childCount: number | null; |
There was a problem hiding this comment.
기존에 존재하던 JSDoc 설명이 삭제되었습니다. Swagger UI에서도 해당 설명이 노출될 수 있도록 @ApiProperty의 description 속성을 사용하는 것이 좋습니다.
| @ApiProperty({ type: Number, nullable: true, example: 3 }) | |
| childCount: number | null; | |
| @ApiProperty({ type: Number, nullable: true, example: 3, description: '디렉토리인 경우 직속 자식 수, 파일인 경우 null' }) | |
| childCount: number | null; |
No description provided.