初始提交:飞球 ETL 系统全量代码
This commit is contained in:
0
docs/ai_audit/changes/.gitkeep
Normal file
0
docs/ai_audit/changes/.gitkeep
Normal file
16
docs/ai_audit/changes/2026-02-13__api-reference-batch2.md
Normal file
16
docs/ai_audit/changes/2026-02-13__api-reference-batch2.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# 审计记录:API 参考文档批量生成(第二批 6 个)
|
||||
|
||||
- **日期**:2026-02-13
|
||||
- **原始原因**:用户 Prompt — 为飞球 ETL 系统生成 6 个高质量 API 参考文档(member_profiles、member_stored_value_cards、member_balance_changes、platform_coupon_redemption_records、group_buy_packages、group_buy_redemption_records),按标杆文档 assistant_accounts_master.md 格式
|
||||
- **直接原因**:按标杆文档格式重写高质量 API 参考文档,替代旧版 test-json-doc 中的分析文档
|
||||
- **Changed**:
|
||||
- `docs/api-reference/member_profiles.md`(新建,15 个字段)
|
||||
- `docs/api-reference/member_stored_value_cards.md`(新建,68 个字段)
|
||||
- `docs/api-reference/member_balance_changes.md`(新建,25 个字段)
|
||||
- `docs/api-reference/platform_coupon_redemption_records.md`(新建,26 个字段)
|
||||
- `docs/api-reference/group_buy_packages.md`(新建,35 个字段)
|
||||
- `docs/api-reference/group_buy_redemption_records.md`(新建,43 个字段)
|
||||
- **Risk/Verify**:
|
||||
- 纯文档变更,无运行时影响
|
||||
- 验证方式:对比 endpoints/、samples/、test-json-doc/ 源文件确认字段覆盖完整
|
||||
- 每个文档均包含 AI_CHANGELOG HTML 注释
|
||||
48
docs/ai_audit/changes/2026-02-13__api-reference-overhaul.md
Normal file
48
docs/ai_audit/changes/2026-02-13__api-reference-overhaul.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# 2026-02-13 API 参考文档全面重构
|
||||
|
||||
## 日期
|
||||
2026-02-13 (Asia/Taipei)
|
||||
|
||||
## 原始原因
|
||||
用户 Prompt(跨多轮对话):
|
||||
> P20260213-170000: "继续"(续接 Task 3 — API 文档全面重构)
|
||||
> P20260213-171500: "继续"(完成文档生成、索引、清理、审计)
|
||||
|
||||
原始需求来自更早的 Prompt(上下文传递):对所有 23+ API 文档进行全面重构,标准化 API 请求/参数存储,为每个 API 生成独立 .md 文档,重命名/迁移目录,废弃旧 test-json-doc 目录。
|
||||
|
||||
## 直接原因
|
||||
旧 `docs/test-json-doc/` 目录命名不规范,文档格式不统一,缺少标准化的 API 参数注册表。需要创建结构化的 `docs/api-reference/` 目录体系。
|
||||
|
||||
## 修改文件清单
|
||||
|
||||
### 新增文件
|
||||
- `docs/api-reference/README.md` — 索引文档
|
||||
- `docs/api-reference/api_registry.json` — 25 个 API 的标准化定义
|
||||
- `docs/api-reference/_api_call_results.json` — API 调用结果(字段提取)
|
||||
- `docs/api-reference/endpoints/*.md` — 25 个端点文档
|
||||
- `docs/api-reference/samples/*.json` — 24 个响应样本
|
||||
|
||||
### 修改文件
|
||||
- `.kiro/steering/structure.md` — 添加 api-reference 目录描述,标记 test-json-doc 为废弃
|
||||
|
||||
### 临时文件(已创建并删除)
|
||||
- `scripts/gen_api_docs.py` — 一次性 API 调用脚本 v1(已删除)
|
||||
- `scripts/gen_api_docs_v2.py` — 一次性 API 调用脚本 v2(已删除)
|
||||
- `scripts/gen_api_md_docs.py` — 一次性 Markdown 生成脚本(已删除)
|
||||
|
||||
## 变更性质判定
|
||||
**无逻辑改动。** 全部为纯文档生成和目录结构描述调整,不涉及:
|
||||
- 业务规则/计算口径
|
||||
- 数据处理/ETL 逻辑
|
||||
- API 行为(未修改 `api/`、`tasks/`、`loaders/` 等运行时代码)
|
||||
- 数据库 schema/表结构
|
||||
- 鉴权/权限
|
||||
|
||||
## Risk/Verify
|
||||
- 风险:极低,纯文档变更
|
||||
- 回归范围:无(不影响任何运行时代码)
|
||||
- 验证步骤:
|
||||
1. 确认 `docs/api-reference/endpoints/` 下有 25 个 .md 文件
|
||||
2. 确认 `docs/api-reference/api_registry.json` 包含 25 个 API 定义
|
||||
3. 确认 `docs/api-reference/samples/` 下有 24 个 .json 文件(settlement_ticket_details 跳过)
|
||||
4. 确认 `.kiro/steering/structure.md` 中 api-reference 和 test-json-doc 描述正确
|
||||
@@ -0,0 +1,30 @@
|
||||
# 2026-02-13 — API 字段漂移报告修正更新
|
||||
|
||||
## 日期
|
||||
2026-02-13 (Asia/Taipei)
|
||||
|
||||
## 原始原因
|
||||
上下文传递续接:前次对话中发现 settlement_records / recharge_settlements / payment_transactions 三个端点因使用 `pageSize`/`pageNo` 参数导致 HTTP 1400 失败。用户确认这些端点需要使用 `limit` 参数(最大 100)。
|
||||
|
||||
## 直接原因
|
||||
需要用正确的 `limit` 参数重新调用这 3 个端点,提取实际 API 字段并与本地 JSON 样本比对,更新字段漂移报告。
|
||||
|
||||
## Changed
|
||||
- `docs/reports/api_field_drift_report_20260213.json` — 更新 3 个实体的比对结果 + 摘要统计
|
||||
- `docs/reports/api_field_drift_report_20260213.md` — 同步更新 MD 格式报告,新增漂移详情、分页参数兼容性说明
|
||||
- 删除临时文件:`_retry_1400.py`、`_retry_goods.py`、`_field_drift_retry.py`、`_retry_results.json`
|
||||
|
||||
## 比对结果
|
||||
| 实体 | 本地字段 | API 字段 | 新增 | 移除 |
|
||||
|------|---------|---------|------|------|
|
||||
| settlement_records | 86 | 91 | 5 | 0 |
|
||||
| recharge_settlements | 86 | 91 | 5 | 0 |
|
||||
| payment_transactions | 10 | 10 | 0 | 0 |
|
||||
|
||||
新增字段(settlement_records / recharge_settlements 共同):
|
||||
- `electricityAdjustMoney`、`electricityMoney`、`realElectricityMoney` — 电费相关
|
||||
- `merVouSalesAmount`、`plCouponSaleAmount` — 商户券/平台券销售额
|
||||
|
||||
## Risk/Verify
|
||||
- 风险:纯文档更新,无代码逻辑变更
|
||||
- 验证:重新运行比对脚本可复现结果;检查 JSON 报告 summary 数值一致性
|
||||
Reference in New Issue
Block a user