Skip to content

v0.11.0 — 枚举值表补全字段路径(data.cost.type 而不是 type)

Choose a tag to compare

@leeguooooo leeguooooo released this 24 Aug 05:35
· 14 commits to main since this release

枚举值表补全字段路径

枚举值表第一列原来只写字段的叶子名,不写它挂在哪一层:

枚举值
| Property | Value |
| type     | dice  |
| type     | free  |

一个响应里出现两个 type(比如 drop.type 和 cost.type)时,读者无从分辨这张表说的是哪一个 —— 而上面的响应 Schema 表给的是完整点路径,两边对不上。

现在第一列是完整路径,写法与响应 Schema 表一致(数组段带 []):

枚举值
| 字段                        | 取值 |
| data.cost.type              | dice |
| data.attacks[].kind         | steal |
| data.rewards_granted[].kind | money |

匹配是靠取值集合消歧的,不是靠出现顺序:从 dereference 过的 api 按 (叶子名, 取值集合) 建索引再回填。drop.type 没有 enum,所以 type + ["dice","free"] 只会命中 cost.type 一个候选。命中不唯一(同名同取值真的挂在两处)时原样保留 —— 宁可少写路径,也不写错路径。

响应侧枚举表表头汉化

widdershins 对请求参数的枚举表发 |Parameter|Value|,对 schema 字段发 |Property|Value|。此前只汉化了前者,schema 字段的枚举表一直漏着英文表头。现在两者都翻成 | 字段 | 取值 | / | 参数 | 取值 |。

更新

npm i -g https://github.com/leeguooooo/openapi-lark/releases/latest/download/openapi-lark.tgz

升级后首次 sync 因版本号纳入 hash 会全量重推一次,带枚举表的接口文档会一并更新。