Skip to content

Bump API schema to 42234aff - #20173

Merged
sentry-api-schema-updater[bot] merged 1 commit into
masterfrom
bot/bump-api-schema-to-42234aff
Oct 22, 2026
Merged

sentry-api-schema-updater[bot] merged 1 commit into
masterfrom
bot/bump-api-schema-to-42234aff

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 22, 2026 12:43pm UTC
sentry-docs Ready Ready Preview Oct 22, 2026 12:43pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 3d07604 into master Oct 22, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-42234aff branch October 22, 2026 12:37
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 22, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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

cursor Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API 404s, client errors on API pages, and API request latency. An issue escalates when API 404s rise or API page loads fall.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The build now fetches OpenAPI schema 42234aff and rebuilds static API reference pages. Requests to /api/<category>/<endpoint>/ then show that schema. sentry-docs must deploy before those pages are live. develop-docs also ships the shared src/ file. It does not render API schema pages. Both ids are in this list because Vercel production deploys for each project come from this repository.

Risk

A removed or renamed operation returns 404 on its old URL. A schema shape that ApiPage cannot render throws a client error on that page. apiCategories() runs inside getDocsFrontMatter for every docs page at build time. A fetch or parse failure can fail the whole site build. A much larger schema may raise TTFB on API pages.

Intended effect

Schema-generated API pages should keep loading after deploy. Those loads use docs.page.load with page_type:api and a set api_category. Absent looks like those loads falling toward zero while other docs pages still load. The published text matching SHA 42234aff is not in telemetry.

Signal Baseline Window Rule Source
docs.page.load with page_type:api and api_category set 405-451 loads per 24h. That is 2.34-2.41% of all docs.page.load. 2026-10-20T12:37:59Z to 2026-10-21T12:37:59Z was 405 loads and 2.34% of 17289 site loads. 2026-10-21T12:37:59Z to 2026-10-22T12:37:59Z was 451 loads and 2.41% of 18676 site loads. Sentry org sentry project docs. Hold in this band or rise. Confirmed when the share stays at or above the band. Absent when schema-generated loads fall toward zero while site docs.page.load stays in 17289-18676 per 24h. Sentry metrics metric.name:docs.page.load page_type:api grouped by api_category, environment production
docs.page.load for api_category:events 94-98 loads per 24h Same two 24h windows. 2d total was 192. Last 24h was 98. Prior 24h was 94. Hold in this band. This is the highest-volume schema category. A drop here with a rise in api/events 404s means the events pages broke. Same query filtered to api_category:events

develop-docs has no queryable intended effect. It does not build API schema pages.

Regression watch

Watch API 404s first. Users see Page Not Found when an operation URL disappears. Also watch client errors on API URLs and site-wide 404s. Site-wide 404s catch a broken generateStaticParams path that drops more than API pages. API request p95 should hold. A large schema can slow those pages. api/alerts already 404s inside the API 404 band.

Signal Baseline Window Rule Source
API 404 rate. docs.page.not_found with requested_path matching api* over API page attempts 1.85-1.86% 2026-10-20T12:37:59Z to 2026-10-21T12:37:59Z was 15 404s over 791 page_type:api loads plus those 404s. 2026-10-21T12:37:59Z to 2026-10-22T12:37:59Z was 16 404s over 851 loads plus those 404s. Hold in this band. Detected when the rate rises above the band. Split by requested_path. A new high path means that operation URL broke. Sentry metrics metric.name:docs.page.not_found requested_path:api* environment production project docs
Client error rate on URLs that contain /api/ over docs.page.load with page_type:api 0.94-1.01% Prior 24h was 8 errors over 791 API loads. Last 24h was 8 errors over 851 API loads. Hold in this band. Detected when the rate rises above the band. Sentry errors environment:production url:*/api/* project docs
Site-wide 404 rate. docs.page.not_found over site docs.page.load plus those 404s 0.46-0.66% Prior 24h was 114 404s over 17289 site loads plus those 404s. Last 24h was 86 404s over 18676 site loads plus those 404s. Hold in this band. Detected when the rate rises above the band. Sentry metrics metric.name:docs.page.not_found environment production project docs
p95 http.server duration for url.full:*/api/* 291-293ms Last 24h p95 was 291.5ms on 229 sampled spans. 2d p95 was 292.7ms on 358 sampled spans. Window 2026-10-20T12:37:59Z to 2026-10-22T12:37:59Z. Traces are sampled at 30%. Hold in this band. Detected when p95 rises above the band. Sentry spans span.op:http.server environment:production url.full:*/api/* project docs

Not observable

The schema commit added 1060 lines and removed 17. The exact operations were not read. New endpoint URLs therefore have no named page-load check. Sampled HTTP 5xx on /api/ was 0 in the last 24h. The 2d 5xx query timed out so the prior 24h 5xx rate is unknown. develop-docs has no page-load denominator for its production error count of 33 in the last 24h and 62 over 2d.

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 74794d21 Deployed Oct 22, 2026 by vercel[bot]
Preview – develop-docs — 74794d21 Deployed Oct 22, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants