[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 21, 2026 5:17pm UTC
sentry-docs	Ready	Preview	Oct 21, 2026 5:17pm 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 adds one public API reference page under Releases. The plan checks that page's loads, other API reference loads, and API-path errors. An issue escalates when API-path errors appear or API reference loads fall.

Services: sentry-docs.

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

Plan

What changed

The docs build now reads OpenAPI schema SHA 9697fe8e47db0be556069ad3c6dd9a8195d1db4a. Requests to /api/releases/retrieve-a-projects-release-setup-progress/ now render the new Releases endpoint page.

sentry-docs must deploy before this page is live. The same source file is in the developer-docs tree. That site does not generate API pages, so this SHA is not live there.

Runtime traces and metrics use Sentry project docs. That tag is not the catalog id.

Risk

A bad schema can omit old endpoint pages. Users then hit 404s on prior API URLs. A schema fetch failure fails the production build. Wrong fields on the new page mis-document the live API.

Intended effect

The new page is live when docs.page.load with api_endpoint:retrieve-a-projects-release-setup-progress rises above zero. Absent looks like that counter still at zero after Releases API pages keep receiving visits. A zero with no Releases visits is unknown, not absent. Sibling Releases traffic is only 21 loads per 24h, so the new page may get no visits in the watch window.

Signal	Baseline	Rule	Source
docs.page.load for api_endpoint:retrieve-a-projects-release-setup-progress	0 loads in 24h. The page does not exist yet.	Rise above 0 after deploy. That is confirmed. Stay at 0 after Releases loads continue is unknown.	Sentry org sentry, project docs, 2026-10-20T17:12:55Z to 2026-10-21T17:12:55Z. Query api_endpoint:retrieve-a-projects-release-setup-progress.

Regression watch

This schema only adds one Releases endpoint. A bad generate step can still drop other API pages. Watch API reference volume, the Releases slice, and API-path errors. Users see those errors and 404s.

Signal	Baseline	Rule	Source
docs.page.load share for page_type:api	793 of 17666 page loads in 24h, 4.5% of all loads	Hold this share. A fall means API pages stopped rendering. A small rise can be the new page.	Sentry org sentry, project docs, 2026-10-20T17:12:55Z to 2026-10-21T17:12:55Z. Queries page_type:api and unfiltered docs.page.load.
docs.page.load for api_category:releases	21 loads in 24h, 2.6% of API loads	Hold above 0 while API loads hold. A drop to 0 on this slice is a regression. This slice is sparse, so treat single-hour noise as unknown.	Same window. Query api_category:releases.
Error events with transaction:*/api/* in production	0 events in 24h	Hold at 0. Any new API-path errors are a regression.	Sentry org sentry, project docs, 2026-10-20T17:12:55Z to 2026-10-21T17:12:55Z. Query environment:production transaction:*/api/*.

If API-path errors rise, inspect client exceptions on /api/ routes and the OpenAPI generate step.

Not observable

The intra-day band for API page-load rate is unknown. A 2d metrics query timed out, so this plan has one 24h point, not a range.

API-scoped 404s for requested_path:api/releases are unknown. That metrics query timed out. Site-wide docs.page.not_found was 109 in 24h and is not an API slice.

Request latency for /api/ pages is unknown. The traces query timed out.

A post-deploy zero on the new endpoint counter does not prove a missing page when Releases visits are also near 21 per 24h.