Repository navigation
Bump API schema to 2b03abf7 - #20101
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 docs page loads, API docs 404s, and client TypeErrors on API docs pages. An issue escalates when those 404s rise or those TypeErrors rise. Services: Mention PlanWhat changedThe docs build fetches openapi-derefed.json from git SHA 2b03abf7. That file matches the prior SHA c8e163b2. Generated API docs pages stay the same. This change is live after sentry-docs deploys. develop-docs does not call apiCategories and does not ship this pin. RiskRisk is low because the OpenAPI document did not change. A failed fetch of the new SHA fails the Vercel build and blocks the deploy. A bad document that still parses could drop API pages or change slugs. That path is unlikely for this pin. If API pages fail to generate, users hit 404s on api paths. If ApiPage cannot render the schema, users see client TypeErrors. Intended effectThis pin does not change generated API docs content. There is no new queryable user behavior. API page loads that hold do not prove the pin. The executor should record intended_effect as unknown. Regression watchIf this pin is wrong, API docs pages fail to generate or fail to render. Watch API docs 404s and client TypeErrors on those pages. Pair each with API docs page load volume. The 404 share may include guessed URLs such as api/gui. The TypeErrors may be third-party script noise on API pages. The last 24h TypeError count is higher than the day before.
Measured values: last 24h had 815 API docs page loads, 13 API 404s, and 6 TypeErrors. The prior 24h had 601 API docs page loads, 7 API 404s, and 0 TypeErrors. Not observableGenerated API page text is not in telemetry. Span query |
Co-authored-by: sentry-api-schema-updater[bot] <271575301+sentry-api-schema-updater[bot]@users.noreply.github.com>
No description provided.