Repository navigation
Bump API schema to 916a2cd6 - #20242
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Please update the IS YOUR CHANGE URGENT? section of the PR description:
This information helps the Docs team prioritize your review. |
|
The plan checks API page loads, API 404s, and production errors. An issue escalates when API page loads drop. An issue also escalates when API 404s or error volume rise. Services: PlanWhat changedThe production build fetches OpenAPI snapshot 916a2cd6. API reference pages rebuild from that snapshot. The snapshot JSON matches the currently pinned generated commit. Only sentry-docs must deploy for this change to go live. develop-docs rebuilds the same SHA. It does not generate API pages. RiskA failed schema fetch blocks the production build. Users then keep the previous pages. A bad schema can drop endpoint pages and return 404. A bad schema can also throw while a page renders. This pin does not change documented endpoints. The watch is still a failed rebuild of the API section. Intended effectThis pin does not add or remove documented endpoints. The intended effect is that API pages keep loading after the rebuild. Absent: API page loads fall toward zero while other page types still load.
Regression watchA dropped or renamed endpoint would 404. A render throw would raise production errors. Put both on the API path, not fleet health alone.
If API 404s rise while platforms page loads hold, treat it as this change. If both drop, treat it as a wider outage. Not observablePageload traces and LCP for /api URLs returned zero rows. Error events filtered to transaction /api/ returned zero rows. HTTP 5xx spans returned zero rows. Field-level correctness of regenerated endpoint docs has no metric. The build-time GitHub fetch of openapi-derefed.json is not in runtime telemetry. The 24h page-load total is incomplete, so the error-rate denominator for all traffic is missing. |
|
Verified in
|
No description provided.