Skip to content

Bump API schema to 6cddbd97 - #19882

Merged
sentry-api-schema-updater[bot] merged 1 commit into
masterfrom
bot/bump-api-schema-to-6cddbd97
Oct 9, 2026
Merged

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 9, 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 9, 2026 2:43pm UTC
sentry-docs Ready Ready Preview Oct 9, 2026 2:43pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 12873a7 into master Oct 9, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-6cddbd97 branch October 9, 2026 14:36
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 9, 2026
@github-actions

github-actions Bot commented Oct 9, 2026

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 9, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API 404s, and client errors. An issue escalates when API page loads fall away or those 404s or errors rise.

Monitoring in production

Services: sentry-docs.

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

Plan

What changed

The static build now fetches OpenAPI from schema SHA 6cddbd9721600d181331c7ed718b93d39f81e732. API category and endpoint pages under /api/ render from that schema. sentry-docs must deploy before the new pin is live. The schema commit does not change openapi-derefed.json, so page bodies should match the prior pin. develop-docs shares this source file but does not generate API pages.

Risk

A broken schema can omit API pages from the static build. Readers then get 404s on former endpoint URLs. A schema that builds can still throw in the API page renderer. Other docs pages share the same catch-all route. A render crash can surface as site-wide client errors.

Intended effect

API pages keep loading after deploy. This pin has no new OpenAPI body, so success is continued API page loads, not new paths. Absent looks like the API page-load share falling toward zero while all page loads hold.

Signal Baseline Window Rule Source
API page loads 2-66 loads per hour. 4.7% of all page loads. 824 of 17460 in 24h. 2026-10-08T14:36:00Z to 2026-10-09T14:36:00Z Hold hourly loads in 2-66. Night hours near 2 are expected. Absent if hours that sat in 30-66 stay at 0 while all page loads hold. Sentry metrics docs.page.load with page_type:api and environment:production. Org sentry, project docs.

Regression watch

This pin can drop or break API pages. Watch API 404s and client errors on the shared catch-all route.

Signal Baseline Window Rule Source
API 404s 15 events in 24h. 1.8% of API page loads. 824 API loads in the same window. Highest path was 8 on api/alerts. 2026-10-08T14:36:00Z to 2026-10-09T14:36:00Z Hold the 404 share near 1.8%. Detected if that share rises far above 1.8% while API page loads hold or fall. Sentry metrics docs.page.not_found with requested_path:api* and environment:production. Org sentry, project docs.
Production errors 0-34 errors per hour. 194 errors in 24h. 1.1% of 17460 page loads. 2026-10-08T14:36:00Z to 2026-10-09T14:36:00Z Hold hourly errors in 0-34. Detected if hours rise above 34 or new API renderer errors appear. Algolia insights fetch failures DOCS-B5T and DOCS-APF are existing noise. Sentry errors environment:production. Org sentry, project docs.

Not observable

The pinned SHA is not emitted at runtime. Errors cannot be scoped to API pages because transactions use /:path*?. Build-time schema fetch failures block deploy and never appear in production. Endpoint text cannot be verified in telemetry.

@cursor

cursor Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages keep loading on this ship.
  • API pages keep loading on this ship.
  • API pages still load after this ship, and 404s and errors stay near baseline.
  • API pages kept loading after this ship.

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 5b6f8815 Deployed Oct 9, 2026 by vercel[bot]
Preview – develop-docs — 5b6f8815 Deployed Oct 9, 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