Repository navigation
Bump API schema to f8158928 - #20183
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. |
|
Generated API reference pages rebuild from a newer schema. Two endpoint pages drop two field names from a query parameter list. An issue escalates when those pages 404 or client errors appear on them. Services: Mention PlanWhat changedThe List an Organization's Replays page omits ota_updates and replay_type from field choices. The Retrieve a Replay Instance page makes the same field-list change. sentry-docs must deploy before this is live. develop-docs also deploys because the shared resolver file changed. develop-docs does not render these OpenAPI pages. RiskA bad schema can fail the docs production build. A render failure can 404 the two Replay API pages. The shared bundle can raise client errors on developer docs after rebuild. Intended effectThe field lists no longer include ota_updates or replay_type. Sentry metrics do not record that page text. Use page-load counts on those two endpoints as a reachability proxy. absent means those two endpoint counts stay at zero after deploy while other API page loads hold. Traffic on these two pages is sparse. A quiet 24h after deploy is not proof the field list changed.
Regression watchThis diff can drop the two Replay API pages or break the shared API page render. It can also ship a new bundle to developer docs. API page_type loads may vary by weekday. This window covers Wednesday and Thursday hours only.
If Replay 404s or Replay URL errors rise, inspect the two endpoint pages and the API category page. Not observableThe field-list text on the two pages is not in telemetry. The executor cannot confirm the enum change from Sentry. Hourly shape for these signals was not sampled. The bands above come from one 24h total. The exact fleet total for docs.page.not_found was not measured. A grouped top-25 query timed out on retry. Page-load volume for develop-docs was not measured. The 29-error watch has no traffic denominator. |
No description provided.