[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 19, 2026 5:01pm UTC
sentry-docs	Building	Preview	Oct 19, 2026 5:01pm 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. The schema document itself did not change. The plan checks API page loads, API 404s, and the API category mix. An issue escalates when API page loads drop or API 404s rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

API reference pages now build from OpenAPI schema commit ca7b22fe. That document matches the prior pin, so published endpoint pages should stay the same. sentry-docs must deploy before those pages use the new pin. develop-docs also ships this commit from the shared src tree. It does not generate OpenAPI pages. Catalog and deploy config name both sites for this repo. OpenAPI generation runs only for sentry-docs.

Risk

A bad schema pin can drop endpoint pages or change their slugs. Readers then see 404s on former API URLs. This pin matches the prior schema, so that blast radius is small. A fetch failure fails the build and does not reach production.

Intended effect

The schema JSON did not change, so no new endpoint page should appear. Success is that API reference pages keep loading at the measured rate. Absent looks like API page loads falling toward zero while other page types keep loading. Platforms had 7210 loads in the same 24h.

These signals live on the product docs site. They become decisive after sentry-docs deploys. A develop-docs-only deploy does not change them.

Signal	Baseline	Window	Source	Rule
API page loads	678 loads per 24h. 4770 loads per 7d, or 681 per day.	2026-10-18T17:02:48Z to 2026-10-19T17:02:48Z and 2026-10-12T17:02:48Z to 2026-10-19T17:02:48Z	Sentry org sentry, project docs. Query metric.name:docs.page.load AND environment:production AND page_type:api.	Hold in 678-681 loads per 24h versus those windows. The band is tight because the 24h rate matched the 7d mean. Treat a drop of tens of percent as absent. Do not treat a move of a few percent as absent.

Regression watch

This pin can still 404 former API URLs if a page fails to generate. Watch 404s on API paths. Also watch the API category mix. A missing category would show as a load drop on that slice.

Signal	Baseline	Window	Source	Rule
API 404s	Top paths in 24h: api/alerts 6, api/detectors 2, api/organizations 2. Those 10 events are 1.5% of the 678 API page loads. This share is a lower bound. The query returns the top 10 paths only.	2026-10-18T17:02:48Z to 2026-10-19T17:02:48Z	Sentry org sentry, project docs. Query metric.name:docs.page.not_found AND environment:production grouped by requested_path.	Hold near those 24h counts. Escalate if API-prefixed rows rise several times above 6, 2, and 2, or if new API paths enter the top 10 at like counts.
API page loads by category	24h loads: untagged 353, events 80, projects 44, organizations 30, crons 23, monitors 21, releases 19, teams 17, explore 16, discover 10.	2026-10-18T17:02:48Z to 2026-10-19T17:02:48Z	Sentry org sentry, project docs. Query metric.name:docs.page.load AND environment:production AND page_type:api grouped by api_category.	Hold near this mix. Escalate if a named category falls toward zero while total API loads hold.

If API 404s rise, inspect the new requested_path values for dropped or renamed slugs.

Not observable

Schema field text on each page has no content hash metric. Client errors scoped to /api/ URLs timed out, so that slice is unknown. Pageload traces do not name the /api/ path, so latency on that path is unknown. The prior-day 404 total was not measured. develop-docs has no OpenAPI pages to watch.