You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
23 lines
2.1 KiB
23 lines
2.1 KiB
2 days ago
|
# 02 — 字段表写回策略：定点补丁 vs 重跑整目录
|
||
|
|
|
||
|
|
Type: grilling
|
||
|
|
Status: resolved
|
||
|
|
|
||
|
|
## Question
|
||
|
|
|
||
|
|
`gen_a4_bru.py` 头部注释写着"幂等：重跑整目录重建（A4 为全新生成，无「人的手改」需保护）"（生成于 customer-e2e 效力时点）。在决定新工具怎么把字段表写回 `.bru` 文件之前，需要先确认这个假设现在还成不成立，再拍板写回方式：
|
||
|
|
|
||
|
|
1. **先查证事实**：`D:\code\crm-api-docs\A4 客户管理\` 下的 99 个目标文件，自 `gen_a4_bru.py` 上次生成以来，有没有被人工/agent 手动改过（可查 git log / 对比生成器如果重跑一次的 diff）？如果有手改痕迹，直接整目录重跑会冲掉那些改动。
|
||
|
|
2. **拍板写回方式**（二选一，或提出第三种）：
|
||
|
|
- **方式A：重跑 `gen_a4_bru.py` 整目录**——新工具作为 `gen_a4_bru.py` 里 `resp_struct_table` 回退路径的替代品接入生成链条内部，重跑一次全量重建 117 个文件（覆盖式，幂等）。
|
||
|
|
- **方式B：定点补丁**——新工具只读取现有 `.bru` 文件，定位"响应 data 结构"/"响应示例"两个小节的既有一行占位文本，原地替换成新生成的字段表+JSON示例，其余内容（请求参数表、meta、请求示例）逐字节保留。
|
||
|
|
3. 如果查证发现已有手改（比如某些端点的说明文字被人工订正过、请求参数表被补充过细节），方式选择要能保护这些改动不被覆盖——这会影响最终选哪种方式。
|
||
|
|
|
||
|
|
## Answer
|
||
|
|
|
||
|
|
已确认采用**方式 B：定点补丁**。
|
||
|
|
|
||
|
|
- 仅在目标 `.bru` 文件中替换“响应 data 结构”和“响应示例”两个区块；请求参数、meta、请求示例及其他既有内容必须保持不变。
|
||
|
|
- `D:\code\crm-api-docs` 当前工作区干净，但 A4 最近一次提交实际新增了 12 个 `.bru` 文件，无法证明旧生成器全量覆盖仍不会抹除已提交的人工作业或后续文档治理内容。
|
||
|
|
- 端点唯一真源尚未由“确认 A4 端点清单的唯一真源”确定；在此之前，禁止重跑旧生成器整目录。
|