Skip to content

Bump API schema to bce6c855 - #19978

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 14, 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 14, 2026 5:22pm UTC
sentry-docs Ready Ready Preview Oct 14, 2026 5:22pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit bb351b5 into master Oct 14, 2026
1 check was pending
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-bce6c855 branch October 14, 2026 17:15
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 14, 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 14, 2026 •

Copy link
Copy Markdown
Contributor

The change pins a new OpenAPI schema for generated API reference pages. The published schema file did not change, so page content should hold. The plan checks API page loads, API 404s, and the error rate. An issue escalates when API 404s rise or the error rate rises.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The docs build now fetches OpenAPI from git SHA bce6c855. Generated API reference pages come from that file. The published OpenAPI file did not change from the prior pin. sentry-docs must deploy before those pages go live. develop-docs also deploys because it shares src/ and skip-build rebuilds both apps. develop-docs does not render the generated API pages.

Risk

A missing or invalid schema fails the production build or drops API pages. Users then see 404s on API reference paths. A shared app rebuild can also raise errors on both sites.

Intended effect

No new API page is expected. The published OpenAPI file is unchanged between the old pin and bce6c855. Confirm the pin by API page loads that hold. Absent looks like the API load share falling below the band while total page loads hold.

Signal Baseline Rule Source
API share of docs.page.load (page_type:api / all docs.page.load) 4.2-4.6% of page loads in 24h. Last 24h 855 of 18775. Prior 24h 801 of 19168. Hold in the band. Do not treat a rise as success. Sentry metrics sentry/docs, environment:production. Windows 2026-10-13T17:15Z/2026-10-14T17:15Z and 2026-10-12T17:15Z/2026-10-13T17:15Z.

Regression watch

A bad schema can drop API pages or break the shared app. Watch API 404s first. Also watch site errors and server 5xx.

Signal Baseline Rule Source
API 404 rate (docs.page.not_found requested_path:api* / API docs.page.load) 1.0-1.3% in 24h. Last 24h 11 of 855. Prior 24h 8 of 801. Hold in the band. Escalate if the rate rises above 2% or 404s rise while API loads hold. Sentry metrics sentry/docs, environment:production. Same 24h windows as above.
Production error rate (error events / all docs.page.load) 0.81-0.94% in 24h. Last 24h 152 of 18775. Prior 24h 181 of 19168. Hold in the band. Escalate if the rate rises above 1.2%. Sentry errors environment:production on sentry/docs, divided by docs.page.load. Same 24h windows.
Server 5xx rate (span.op:http.server status 500-599 / all http.server) 0% in 24h. 0 of 7637 server spans. Status 200 was 7437. Hold at 0. Any 5xx is a fault. Sentry traces sentry/docs, environment:production, window 2026-10-13T17:15Z/2026-10-14T17:15Z.
develop-docs production errors 28 errors in last 24h. 38 in prior 24h. Sampled pageload plus navigation was 2100 in last 24h. Hold near 28-38 errors per 24h while sampled traffic holds. Escalate if errors rise above 40. Sentry errors sentry/develop-docs, environment:production. Traces span.op:[pageload,navigation]. Same 24h windows.

Client traces use a 30% sample for users. Metrics and errors are not sampled that way. If API 404s rise, inspect docs.page.not_found by requested_path.

Not observable

The SHA that the running build fetched is not in production telemetry. Field-level API page text is not measured. Build-time fetch of the schema is not in these signals. Most page errors use transaction /:path*?, so they do not filter by /api/.

This branch was successfully deployed

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