docs: API文档准确性修复 — schema命名/重复端点/workspace_id清理/README更新 #55

2026-06-27T18:16:18+08:00

xiaoxia commented

2026-06-27 18:16:18 +08:00

变更内容

1. 修正上传端点 schema 命名 (P0)

新增 UploadAssetRequest Pydantic 模型，替代 FastAPI 自动生成的 Body_upload_asset_api_v1_upload_post
使用 Annotated[UploadAssetRequest, Form()] 模式，OpenAPI 文档中显示为清晰的 UploadAssetRequest

2. 清理认证重复端点 (P1)

移除 POST /api/v1/auth/forgot-password（旧路径）
移除 POST /api/v1/auth/reset-password（旧路径）
保留 POST /api/v1/auth/password/forgot 和 POST /api/v1/auth/password/reset

3. 清理 workspace_id 残留 (P1)

Response schema 移除: EditTemplateResponse, EditPlanResponse, ProjectAssetDiagnosisResponse, ProjectTaskResponse, ProjectTitleResponse
Request schema 改为可选: CreateEditPlanRequest, AutoGenerateEditPlanRequest, CreateProjectTitleRequest
路由参数改为可选: projects.py 的 list_projects workspace_id 查询参数
内联 schema 改为可选: project_management.py 中的 CreateTaskRequest, CreateMilestoneRequest, CreateTaskIssueRequest 及其 Response

4. 更新 README (P1)

移除不存在的功能描述（refresh token、工作空间隔离、角色权限、订阅计划）
修正仓库地址为 git.xiaoxiajianji.com
更新 API 路径列表与实际 OpenAPI schema 一致
清理末尾测试日志噪音

## 变更内容 ### 1. 修正上传端点 schema 命名 (P0) - 新增 `UploadAssetRequest` Pydantic 模型，替代 FastAPI 自动生成的 `Body_upload_asset_api_v1_upload_post` - 使用 `Annotated[UploadAssetRequest, Form()]` 模式，OpenAPI 文档中显示为清晰的 `UploadAssetRequest` ### 2. 清理认证重复端点 (P1) - 移除 `POST /api/v1/auth/forgot-password`（旧路径） - 移除 `POST /api/v1/auth/reset-password`（旧路径） - 保留 `POST /api/v1/auth/password/forgot` 和 `POST /api/v1/auth/password/reset` ### 3. 清理 workspace_id 残留 (P1) - **Response schema 移除**: EditTemplateResponse, EditPlanResponse, ProjectAssetDiagnosisResponse, ProjectTaskResponse, ProjectTitleResponse - **Request schema 改为可选**: CreateEditPlanRequest, AutoGenerateEditPlanRequest, CreateProjectTitleRequest - **路由参数改为可选**: projects.py 的 list_projects workspace_id 查询参数 - **内联 schema 改为可选**: project_management.py 中的 CreateTaskRequest, CreateMilestoneRequest, CreateTaskIssueRequest 及其 Response ### 4. 更新 README (P1) - 移除不存在的功能描述（refresh token、工作空间隔离、角色权限、订阅计划） - 修正仓库地址为 git.xiaoxiajianji.com - 更新 API 路径列表与实际 OpenAPI schema 一致 - 清理末尾测试日志噪音

xiaoxia force-pushed fix/api-docs-update from 466e5ea3ee to dbaed1f70c

2026-06-27 19:02:40 +08:00

Compare

xiaoxia merged commit fdecb4c91d into develop

2026-06-27 19:02:55 +08:00

xiaoxia referenced this issue from a commit

2026-06-27 19:02:57 +08:00

Merge PR #55: docs API文档准确性修复

xiaoxia referenced this issue from a commit

2026-06-27 19:11:48 +08:00

Merge PR #55: docs API文档准确性修复

xiaoxia referenced this issue from a commit