yaosutu
|
89a1938cb9
|
docs(v3-order): 按代码事实修订 §1/§2 changelog(fix issue #1 + 补充 5 项)
回复 hl-api-changelog#1 前端反馈的 5 处契约不明 / 冲突,并同步补足 4 处文档与代码不一致:
§1 订单核心模块(15 处修改):
- §3.1/§3.2/§3.3/§3.14 示例值:orderStatus/flowStatus 全部从中文标签改为英文枚举值
(后端 OrderInfo.orderStatus/flowStatus 直接透传 DB 列的英文枚举字符串)
- §3.3 OrderMainVO 字段表:
* customerName/customerPhone (admin 明文) → customerName + customerPhoneMasked(admin 也脱敏)
* exceptionBadges/progressStepper 标注「运行时暂返 null,OrderInfoConverter 派生逻辑待 Issue 接通」
* 新增 6 个 Tab 状态徽标字段(contractStatus/insuranceStatus/refundStatus/hasRefund/hasServiceStandard/hasFinanceDetail)
* subStatus 枚举补 NOT_APPLICABLE + 列示 ASSIGN_PARALLEL 子项结构
* 主聚合示例 transportPlanIds 改用真实雪花 ID(19 位)String
- §3.11 取消预览业务边界:粗状态集改英文枚举 + 说明 v3 已删「已确认」
- §3.14 transition:eventCode 入参表内联 9 个值,便于前端跳读
- §6.2 orderStatus:全表替换为 10 个英文枚举(PENDING_PAY/PENDING_COMPLETE/CUSTOMIZING/PENDING_DEPARTURE/PENDING_BALANCE/TRAVELLING/REVIEWING/SETTLED/REFUNDING/CANCELLED)
- §6.3 flowStatus:全表替换为 13 个英文枚举(AWAITING_DEPOSIT/.../CANCELLED_BEFORE_PAY)
- §6.4 consultantSource:补 SHARED + ROUND_ROBIN,说明 user-service 透传规则
- §6.17 加后端 enum 路径备注
§2 traveler 模块(9 处修改):
- §3.1 出行人列表:每条 17 字段 → 16 字段(off-by-one 笔误)
- §3.1/§3.3 curl 示例:路径 /travelers → /traveler/list 和 /traveler/add(对齐字段表与代码 @PostMapping)
- §3.1 transportPlanIds:补全局 Long→String 序列化规则脚注 + 示例值改真实雪花 ID
- §3.4 错误码段位让位:581119 → 581106(已签合同禁删),581120 → 581107(最后成人禁删)
(DB 段位 581119/581120 已分别被 TRAVELER_ID_CARD_DUPLICATE / TRANSPORT_PLAN_NOT_FOUND 占用)
- §3.9 smart-parse 错误码段位让位:581120/581121/581122/581123 → 581131/581132/100501/581134
(581122 限流走 HL 全局 CommonErrorCode.RATE_LIMITED)
- §12 注意事项同步删人错误码
关联:
- Issue: #1
- 验证代码 commit: HL@dev-v3 47d24228
- 验证报告: HL/.claude/tmp-changelog/issue1-analysis.md(仅本地)
|
2026-05-19 10:28:11 +08:00 |
|
|
|
2b1c3e0859
|
fix(§2): traveler 4 接口路径对齐实际 Controller(动词风格)
QA 验收发现 §2 changelog 写的 4 个 traveler 接口路径与 hl-order-service-v3 实际 Controller 不一致:
| § | 原 changelog | 实际 Controller |
|---|---|---|
| 2.1 列表 | GET /travelers | GET /traveler/list |
| 2.3 新增 | POST /travelers | POST /traveler/add |
| 2.4 软删 | DELETE /travelers/{id} | POST /traveler/{id}/delete |
前端按 changelog 调会 404/405。本次修 changelog 对齐实际 Controller,保留动词式风格。
关联:HL Issue #2533 / PR #2534(QA 暴露)
Co-Authored-By: Claude <noreply@anthropic.com>
|
2026-05-18 19:59:04 +08:00 |
|
yaosutu
|
2059566991
|
fix(§2): 删 §2.7 internal feign 接口节(前端 changelog 不收 internal)
按 CLAUDE.md changelog 受众判定:
- /v3/admin/* → 前端 changelog(本仓库 hl-api-changelog)
- /v3/internal/* → 后端 changelog(hl-backend-changelog,受众=其他后端服务/运维)
§2.7 GET /v3/internal/order/orders/{orderId}/travelers 是 internal Feign
跨服务接口(合同/保险服务调用),前端不消费,移出本文档:
- §0 模块全貌:删 §2C internal Feign 行,合计 11→10,加范围说明
- §1 接口背景:删 §2.7 解密审计行
- §2 变更清单:删第 9 行,剩 10 条
- §3.9 §2.7 internal feign 节整段删除
- §3.10 §2.8 smart-parse 重编号为 §3.9
- §3.11 §2.9 validate 重编号为 §3.10
- §6.9 purpose(Feign 调用目的)枚举删除
- §6.10 missingFields 重编号为 §6.9
- §11 推送范围:11→10 + 说明 §2.7 走后端 changelog
- §12 注意事项:删 internal 公网约束行
- §13 关联:加 §2.7 单独走后端 changelog 链接 + Issue #2525 备注
§2.7 后端 changelog 会单独推到 hl-backend-changelog 仓库。
|
2026-05-18 17:31:11 +08:00 |
|
yaosutu
|
757a5dd60b
|
docs(order-v3): §2 traveler 模块 11 接口首推(§2.8 smart-parse 字段先定待 wx 实现)
v3 traveler 模块(出行人 + 大交通)全 11 接口完整契约:
§2A 出行人 admin CRUD(4 接口):
- §2.1 GET /v3/admin/order/{id}/travelers 出行人列表
- §2.2 POST /v3/admin/order/{id}/traveler/batch-edit 批量编辑(upsert)
- §2.3 POST /v3/admin/order/{id}/travelers 单个新增
- §2.4 DELETE /v3/admin/order/{id}/travelers/{travelerId} 软删
§2B 大交通批次 admin CRUD(4 接口):
- §2.6.1 GET /v3/admin/order/{id}/transport-plans 列表
- §2.6.2 POST /v3/admin/order/{id}/transport-plans 新增
- §2.6.3 PUT /v3/admin/order/{id}/transport-plans/{planId} 编辑
- §2.6.4 DELETE /v3/admin/order/{id}/transport-plans/{planId} 软删
§2C internal Feign(1 接口):
- §2.7 GET /v3/internal/order/orders/{orderId}/travelers 跨服务查(含明文 + 解密审计)
§2D 动词类操作(2 接口):
- §2.8 POST /v3/admin/order/{id}/traveler/smart-parse ⏳ wx 实现中(Issue #2526)
- §2.9 GET /v3/admin/order/{id}/traveler/validate 出行人信息校验
按 SKILL.md 新约定(多接口 changelog 按接口自含 + 示例必含请求/响应)组织:
- §3.1~§3.11 共 11 子节,每节含使用场景/入参/出参/错误码/业务边界/请求+响应示例
- §6 枚举集中 10 个(travelerType / gender / idType / profileStatus / direction
/ mode / transportType / selfDrivePeriod / purpose / missingFields),按字段
分组 + 标使用接口位置
设计文档同步:API-SPEC v5.50(§2 章节路径全部 RESTful 复数化,与 v3 代码对齐)。
1125 行 / 13 节齐全 / §2.8 字段先定标 ⏳ 待 wx 实现立即可对接。
|
2026-05-18 17:08:21 +08:00 |
|