Просмотр исходного кода

📝 docs(files): 完善文件上传策略响应Schema文档

- 详细定义file对象各字段的类型、约束和示例说明
- 添加字段描述信息,包括文件ID、名称、类型、大小等关键属性
- 移除原FileSchema引用,改为显式定义以提高文档清晰度
yourname 3 месяцев назад
Родитель
Сommit
4dfbd530f9
1 измененных файлов с 47 добавлено и 1 удалено
  1. 47 1
      packages/server/src/api/files/upload-policy/post.ts

+ 47 - 1
packages/server/src/api/files/upload-policy/post.ts

@@ -8,8 +8,54 @@ import { authMiddleware } from '../../../middleware/auth.middleware';
 import { parseWithAwait } from '../../../utils/parseWithAwait';
 
 
+// 创建文件上传策略响应Schema,不包含关联的uploadUser字段
 const CreateFileResponseSchema = z.object({
-  file: FileSchema,
+  file: z.object({
+    id: z.number().int().positive().openapi({
+      description: '文件ID',
+      example: 1
+    }),
+    name: z.string().max(255).openapi({
+      description: '文件名称',
+      example: '项目计划书.pdf'
+    }),
+    type: z.string().max(50).nullable().openapi({
+      description: '文件类型',
+      example: 'application/pdf'
+    }),
+    size: z.number().int().positive().nullable().openapi({
+      description: '文件大小,单位字节',
+      example: 102400
+    }),
+    path: z.string().max(512).openapi({
+      description: '文件存储路径',
+      example: '/uploads/documents/2023/project-plan.pdf'
+    }),
+    description: z.string().nullable().openapi({
+      description: '文件描述',
+      example: '2023年度项目计划书'
+    }),
+    uploadUserId: z.number().int().positive().openapi({
+      description: '上传用户ID',
+      example: 1
+    }),
+    uploadTime: z.coerce.date().openapi({
+      description: '上传时间',
+      example: '2023-01-15T10:30:00Z'
+    }),
+    lastUpdated: z.date().nullable().openapi({
+      description: '最后更新时间',
+      example: '2023-01-16T14:20:00Z'
+    }),
+    createdAt: z.coerce.date().openapi({
+      description: '创建时间',
+      example: '2023-01-15T10:30:00Z'
+    }),
+    updatedAt: z.coerce.date().openapi({
+      description: '更新时间',
+      example: '2023-01-16T14:20:00Z'
+    })
+  }),
   uploadPolicy: z.object({
     'x-amz-algorithm': z.string(),
     'x-amz-credential': z.string(),