Skip to content

docs(api): daily audit 2026-09-08 - fix api-catalog RUM accordion & counts - #371

Open
flashduty[bot] wants to merge 1 commit into
mainfrom
api-review/20260908T084332Z
Open

docs(api): daily audit 2026-09-08 - fix api-catalog RUM accordion & counts#371
flashduty[bot] wants to merge 1 commit into
mainfrom
api-review/20260908T084332Z

Conversation

@flashduty

@flashduty flashduty Bot commented Sep 8, 2026

Copy link
Copy Markdown

api-review 每日审计 2026-09-08

对 Flashduty 公开 API OpenAPI 3.1 规格执行每日审计(等价于 /api-review --mode generate --scope all --auto)。本轮发现并修复 api-catalog.mdx 结构/计数漂移,spec 文件与 docs.json 无需改动。本 PR 0 个 operation 增加、0 个删除,仅做目录结构/计数修复(见下)。

变更内容

文件 变更
en/openapi/api-catalog.mdx 恢复 RUM <Accordion> 开合标签;Monitors 计数 40→32;intro 总数 354→346
zh/openapi/api-catalog.mdx 同上(zh 侧)

差异说明(逐条可解释)

  1. RUM accordion 丢失:commit 33d085e(remove ServiceMap,2026-09-08 合入 main)在删 ServiceMap 行时误删了 RUM 的 <Accordion title="RUM (41 endpoints)"> 开标签及前一条 Monitors </Accordion>,导致 RUM 的 41 行被吞进 Monitors accordion 内、RUM 模块在目录中消失。本次在 Monitors/RUM 边界(### Monitor utilities 空表后)恢复 </Accordion> + <Accordion title="RUM (41 endpoints)">
  2. Monitors 计数滞后:spec 中 monitors 模块 40→32(ServiceMap 33d085e + monit-agent 68d8181 移除后由 40 减至 32),目录标题同步 40→32。
  3. intro 总数滞后:总路径数 346(193 on-call + 32 monitors + 41 rum + 53 AI SRE + 27 platform),目录 intro 354→346。

验证

  • registry 对照parse_pgy_registry.py 解析 fc-pgy api_test.goauth=all 公开行 345 条;spec 346 条路径,唯一差异为 POST /monit/rule/dstypes(属 monitors 模块,因 monit-webapi 不在 GitHub、按规则沿用 HEAD,非新漂移)。
  • 无 operation 增删 → docs.json 导航与 {en,zh}/api-catalog.mdx 均无路径滞留/缺失;本轮 docs.json 未改动
  • 结构校验:修复后 en/zh 目录各 5 个 <Accordion>,开合配对 opens==closes;每模块行数与标题一致(193/32/41/53/27);目录路径 0 条不在 spec 中。
  • lint_openapi.py:OK,12 个 spec 文件,无违规。
  • spec 文件未改动api-reference/*.json 零 diff(git diff --stat 仅含 2 个 catalog 文件)。

未解决 / 说明

  • unresolved(registry 行找不到 handler):无。
  • 构造示例说明:本轮未新增/修改任何 operation,未构造示例值。
  • monitors 模块沿用 HEAD:monit-webapi/monit-edge 不在 flashcatcloud org(GitHub 不存在),monitors 模块内容沿用 HEAD 并记录说明。

…ounts

- Commit 33d085e (remove ServiceMap) deleted the RUM <Accordion> opening tag
  and the preceding Monitors </Accordion>, leaving RUM's 41 rows stranded
  inside the Monitors accordion. Restored </Accordion> + <Accordion title="RUM">
  at the Monitors/RUM boundary in both {en,zh}/openapi/api-catalog.mdx.
- Corrected stale counts introduced by the ServiceMap (33d085e) and
  monit-agent (68d8181) removals merged after the 2026-09-07 audit:
  Monitors 40 -> 32 (32 paths in monitors spec), intro total 354 -> 346.
- No operations added or removed -> docs.json untouched; api-reference/*.json
  spec files untouched (verify against live registry: 345 public rows, spec
  has 346 paths, lone diff = POST /monit/rule/dstypes which is carried from
  HEAD because monit-webapi is not on GitHub).
- lint_openapi.py: OK, 12 spec files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants