Repository navigation
Bump API schema to 1aaa7af8 - #20230
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 watches the projects field type on the create-release API docs page. It also watches API docs 404s, errors on API docs pages, and release API docs page loads. An issue escalates when those 404s or errors rise. Services: Mention PlanWhat changedThe create-release API docs page now labels the projects body field as array(string). Today that page labels it array(undefined). The OpenAPI pin moved to 1aaa7af8 and types that field in two request-body copies. sentry-docs must deploy before the page updates. Shared src also builds into develop-docs. develop-docs does not render OpenAPI pages, so this plan does not watch it. RiskA bad schema can fail the production build. Then the site keeps the old pages. A slug change would 404 API docs pages. This diff only adds a string item type, so a build break is unlikely. If the API page component throws on the new type, array parameter labels on API endpoint pages can break. Readers of the create-release docs page would then see a blank page or a 404. Intended effectConfirmed means the create-release docs page labels projects as array(string). Absent means that page still labels projects as array(undefined), or the page returns 404. Page-load counts cannot prove the new label. Three loads of that endpoint in the last 24h only show the page still exists.
Regression watchThis diff can 404 API docs pages or throw in the API page component. Watch 404 rate, API docs errors, and release API docs volume. At least one 404 or error rise on those pages is a regression. Ignore a single hour above 50 errors. That pattern matched a crawler burst at 2026-10-25T13:00Z.
Not observableSentry metrics do not record the projects type string. Confirm that label with the live page GET in Intended effect. Prior-day failure count for release API docs pageloads was not returned as a series. Fleet-wide docs errors ran 860 in the current 24h and spiked above 3000 per hour from 2026-10-25T10:00Z to 2026-10-25T12:00Z. Those events are mostly unrelated promise rejections. Do not use fleet-wide error count. Pageload p95 on release API docs is sparse. Hours with traffic ranged 137-3675 ms. Pooled 24h p95 was 3180 ms. That spread is too wide for a tight latency rule. |
No description provided.