docs(api): daily audit 2026-08-25 — align stale envelope schemas (safari + consolidated) - #310
Merged
Merged
Conversation
…afari + consolidated
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Daily api-review audit (2026-08-25). The full generate pipeline was not run this round: the knowledge pack is missing
runbooks/api-review-apply-patches.pyandrunbooks/api-review-daily.md(confirmed by the pack sentinel: 20 files, no api-review runbook; established since 2026-08-24), so per iron rule 6 the generator stays blocked. Per the documented fallback, a deterministic audit on HEAD was performed instead (fixed content below), then surgical fixes applied.Audit results (HEAD, all deterministic)
fc-pgy/logic/api/api_test.go@08c824a4: 920 rows, 337auth: all; public set (auth=all, path not/event/push/) = 337 unique paths.eba0b02): on-call 191, platform 27, monitors 42, rum 35, safari 42 = 337 — registry ↔ spec comparison is a perfect match in both directions (0 registry-only, 0 spec-only).openapi.en/zh.json: 337 paths, identical to split union; en/zh parity: 0 path / operationId / schema-name diffs (all 5 modules).docs.jsonpages allow-list covers 191/27/42/35/42 ops (pages-only = 0, spec-only = 0);en/openapi/api-catalog.mdx: 337 rows, stated 337, module counts 191/42/35/42/27;zhsame 337 rows.$refs resolve, no duplicate operationIds, OpenAPI 3.1.0 → no endpoint added or removed → no docs.json / api-catalog.mdx changes needed.Drift found and fixed (1 finding)
Stale lean envelope schemas in
safari.openapi.{en,zh}.json+ consolidatedopenapi.{en,zh}.json— committed internal drift:ErrorCode: missingx-enumDescriptions(per-value descriptions for all 20 wire codes), missingexample, and a plain description instead of the canonical code/HTTP/meaning table.DutyError: missingproperties.message.example; zh files carried English descriptions.ErrorResponse: zh files carried English description.Canonical truth = the on-call split, which is byte-identical to platform/monitors/rum (verified). Fix: replaced the three schema definitions in the 4 stale files with the canonical objects (+112/−16 lines across 4 files):
api-reference/safari.openapi.en.jsonapi-reference/safari.openapi.zh.jsonapi-reference/openapi.en.jsonapi-reference/openapi.zh.jsonVerification: sort-key deep compare vs HEAD yields exactly 22 differences, every one in the three envelope schemas (no order churn); after the fix all 12 spec files carry an identical canonical envelope (explicit cross-file check); path counts unchanged (337); re-run JSON validation passes.
Notes