Files
Neo-ZQYY/docs/audit/changes/2026-02-14__api-doc-reorg-field-grouping.md

3.0 KiB
Raw Blame History

审计记录API 文档归档至 summary/ + 字段分组修正

  • 日期2026-02-14Asia/Shanghai
  • Prompt-IDP20260214-130000

原始原因

用户 Prompt跨多轮对话

对 docs/api-reference 下,主要的 25 个文件归档到合适的目录,区别零散的文件。这 25 个文件,逐个检查描述是否有问题,我发现响应字段详解的归类组别很乱,所属组别不科学。并逐个文件进行修正。

直接原因

25 个 API 参考文档中,多个文件的"四、响应字段详解"章节存在字段归类错误:非时间字段被混入"时间"组、非状态字段被混入"状态与类型"组等。需要逐文件审计并修正分组。

Changed

Part A文件归档已在前次对话完成

  • 25 个 summary MD 文件从 docs/api-reference/ 根目录移至 docs/api-reference/summary/
  • docs/api-reference/README.md 更新目录结构和链接

Part B字段分组修正本次完成

文件 问题 修正
group_buy_redemption_records.md 4.9"时间"混入 9 个分摊/折扣/ID 字段 新增 4.9"结算分摊金额"9 字段),时间重编号为 4.10
group_buy_packages.md 4.7"状态与类型"混入排序/台区列表/关联 ID 4.7 精简;新增 4.8"关联 ID 与台区列表"create_time 移至 4.9"时间"
member_balance_changes.md 4.8"时间"混入 principal_* 三个本金字段 新增 4.8"本金明细"3 字段),时间重编号为 4.9
member_profiles.md 4.7"时间元数据"混入消费统计/组织/注册来源 新增 4.7"消费与充值统计"、4.8"组织归属与注册来源",时间重编号为 4.9;字段总数 15→21
tenant_goods_master.md 4.8"时间与删除状态"混入 not_sale/is_delete 拆分为 4.8"时间元数据" + 4.9"状态与删除标志"
store_goods_sales_records.md 4.8"时间"混入 coupon_share_money coupon_share_money 移至 4.5"积分、优惠券与抵扣"
site_tables_master.md 4.7"时间元数据"混入 order_id 新增 4.7"当前订单",时间重编号为 4.8

审计通过无需修改的文件18 个)

assistant_accounts_master, settlement_records, assistant_cancellation_records, payment_transactions, refund_transactions, recharge_settlements, platform_coupon_redemption_records, store_goods_master, stock_goods_category_tree, goods_stock_summary, table_fee_discount_records, tenant_member_balance_overview, table_fee_transactions前次已修, member_stored_value_cards前次已修, assistant_service_records, member_consumption_statistics, goods_stock_movements, settlement_ticket_details

治理文档

  • .kiro/steering/structure.md — 新增 summary/ 子目录描述
  • docs/api-reference/README.md — AI_CHANGELOG 追加

Risk/Verify

  • 风险:纯文档分组调整,无代码/数据库/运行时影响
  • 验证:逐文件统计各分组字段数总和,确认与标题声明的字段总数一致
  • 回归范围:无(文档变更不影响 ETL Connector