[sentry-api-schema-updater]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
develop-docs	Building	Preview	Oct 16, 2026 10:50pm UTC
sentry-docs	Building	Preview	Oct 16, 2026 10:50pm UTC

[github-actions]

Please update the IS YOUR CHANGE URGENT? section of the PR description:

• Select exactly one option.
• If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

[cursor]

The change rebuilds API reference pages from a new schema pin with the same OpenAPI document. The plan checks API page loads, API 404s, and failed API pageloads. An issue escalates when API 404s rise or those pageloads fail more often.

Monitoring in production

Services: sentry-docs, develop-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Requests to API category and endpoint pages now build from schema SHA b1eac6b057846f1a8bcdc59e54c259e361679990. The dereferenced OpenAPI document is the same as SHA 7c51e556571ea1034763ddaa89b982af3365cb71. sentry-docs must deploy before those pages are live. develop-docs also deploys this commit because it shares the app tree. Only the sentry-docs build fetches the schema and adds /api/ routes.

sentry-docs is the ship that serves those pages. develop-docs is included because Vercel deploys the same commit to both projects.

Risk

A bad pin can fail the static build or drop API pages from static params. Users then get 404s on old API URLs. A schema shape mismatch can throw while an API page renders. Those failures stay on the API reference path. develop-docs does not render those pages. A compile break in the shared page module can fail both deploys.

Intended effect

The pin is live when API page loads hold their share of all page loads. The OpenAPI JSON did not change, so no new endpoint page is expected. Absent looks like the API page-load share falling toward zero while other page types hold.

API page-load share is docs.page.load with page_type:api divided by all docs.page.load in production.

Signal	Baseline	Rule	Source
API page-load share	4.7-4.8% of all page loads. 742 API loads vs 15782 total in 2026-10-15T22:51:12Z to 2026-10-16T22:51:12Z. 920 vs 19395 in 2026-10-14T22:51:12Z to 2026-10-15T22:51:12Z.	Hold in 4.7-4.8%. Confirmed if the share stays in that band. Absent if the share falls below 2% while total page loads stay in 15000-20000 per 24h.	Sentry org sentry project docs. Metric docs.page.load. Query page_type:api environment:production vs environment:production.

Regression watch

A wrong pin can 404 old API URLs or fail API pageloads. Watch the API path, not the whole site. Current /api/ client errors are third-party fetch failures from kapa.ai and Algolia. Treat those titles as noise. Escalate on new error types or a rate above the band.

API 404 share is docs.page.not_found with requested_path:*api* divided by API page loads. Pageload failure share is failure_count() over count() for span.op:pageload with url.full:*/api/*. Traces are sampled at 30%.

Signal	Baseline	Rule	Source
API 404 share	0.4-1.2% of API page loads. 9 404s vs 742 API loads in 2026-10-15T22:51:12Z to 2026-10-16T22:51:12Z. 4 vs 920 in 2026-10-14T22:51:12Z to 2026-10-15T22:51:12Z. Six of the nine recent 404s were api/alerts.	Hold in 0.4-1.2%. Detected if the share rises above 2% or new api/ paths dominate.	Sentry org sentry project docs. Metric docs.page.not_found. Query requested_path:*api* environment:production.
API pageload failure share	1.7-2.3% of sampled API pageloads. 7 failures vs 310 pageloads in 2026-10-15T22:51:12Z to 2026-10-16T22:51:12Z. 6 vs 353 in 2026-10-14T22:51:12Z to 2026-10-15T22:51:12Z.	Hold in 1.7-2.3%. Detected if the share rises above 4%.	Sentry org sentry project docs. Spans query span.op:pageload url.full:*/api/* environment:production. Fields count(), failure_count().
Client error share on /api/ URLs	0.2-0.4% of API page loads. 3 errors vs 742 API loads in 2026-10-15T22:51:12Z to 2026-10-16T22:51:12Z. 2 vs 920 in 2026-10-14T22:51:12Z to 2026-10-15T22:51:12Z. Titles were DOCS-BE6, DOCS-BDZ, and DOCS-APF.	Hold in 0.2-0.4%. Detected if the share rises above 1% or new error types appear on API pages.	Sentry org sentry project docs. Errors query environment:production http.url:*/api/*.

Not observable

The running build does not emit the schema SHA. You cannot confirm the pin from telemetry. Vercel build logs for the GitHub schema fetch are not in this Sentry project. Exact field text on an endpoint page is not in metrics.