[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	Ready	Preview	Oct 20, 2026 12:07pm UTC
sentry-docs	Ready	Preview	Oct 20, 2026 12:07pm 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 pins a new OpenAPI schema for API reference pages. The plan checks API page loads, API 404s, and errors on those pages. An issue escalates when API page loads drop or those 404s rise.

Services: sentry-docs.

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

Plan

What changed

The production build fetches OpenAPI from GitHub at schema SHA a1e7464c55cb6eabf4565482e22c9c8002b8ee3b. API category and endpoint pages under /api/ render from that schema. The schema JSON matches the prior pin. The upstream diff only changed the changelog and package version. sentry-docs must deploy before the new pin is live.

Risk

A bad schema can omit or rename API pages during static generation. Users who open those old URLs then get a 404. A schema parse failure fails the production build. Then the pin does not ship. The matching JSON makes a slug change unlikely this time.

Intended effect

The pin does not add a new API page. The schema JSON did not change. Confirmed means API pages still load after deploy. Absent means page_type api loads fall toward zero while other page loads hold.

Signal	Baseline	Rule	Source
Share of docs.page.load with page_type api	2.5-5.8% of all docs.page.load per complete UTC day from 2026-10-14 through 2026-10-19. Last 24h was 807 of 16842, or 4.8%.	Hold in 2.5-5.8% over a rolling 24h.	Sentry org sentry, project docs. Query metric.name:docs.page.load AND environment:production grouped by page_type. Window 2026-10-19T12:01:05Z to 2026-10-20T12:01:05Z.

Regression watch

This pin can 404 old API URLs if slugs change. It can also throw on API pages if render breaks. Do not use http.url:*api*. Ingest URLs also contain /api/ and are not this path.

Signal	Baseline	Rule	Source
API 404 rate: docs.page.not_found with requested_path api* over docs.page.load with page_type api	0.4-2.3% per complete UTC day from 2026-10-14 through 2026-10-19. Last 24h was 13 of 807, or 1.6%. Daily 404 counts were 3-15.	Hold in 0.4-2.3% over a rolling 24h. Rise above the band is a regression.	Sentry org sentry, project docs. Query docs.page.not_found with requested_path:api*. Pair with docs.page.load page_type:api. Window 2026-10-19T12:01:05Z to 2026-10-20T12:01:05Z.
Error events on API page paths	0 events in the last 24h for transaction:/api/* or url.path:/api/*.	Hold at 0. Any new error on those paths is a regression.	Sentry org sentry, project docs. Query environment:production (transaction:/api/* OR url.path:/api/*). Window 2026-10-19T12:01:05Z to 2026-10-20T12:01:05Z.

Not observable

The pinned SHA is not in production telemetry. Page body text for API endpoints is not in metrics. Build-time GitHub fetch is not in Sentry after a successful deploy.