Skip to content

Bump API schema to 4bc5d301 - #19845

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 200617a into master Oct 7, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-4bc5d301 branch October 7, 2026 19:03
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 7, 2026
@github-actions

github-actions Bot commented Oct 7, 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 7, 2026 •

Copy link
Copy Markdown
Contributor

The change rebuilds generated API reference pages from a new schema pin. The pinned OpenAPI document is unchanged, so page content should hold. The plan checks API page loads, API not-found counts, and client errors. An issue escalates when API page loads drop or those errors rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

Build output for generated API reference pages now pins schema 4bc5d301. Requests to those pages should keep serving the same catalog. The OpenAPI file at this pin matches pin 3099d249. sentry-docs must deploy before the pin is live. develop-docs also ships this shared src/ file. develop-docs does not render the generated API catalog.

Risk

A bad pin can omit endpoints or rename slugs. Readers then get not-found on former API URLs. A schema shape change can crash API page render. That failure reaches every generated API category and endpoint page. A broken shared page module can also fail the develop-docs boot.

Intended effect

The generated API catalog stays reachable after deploy. Absent looks like API page loads near zero while other page types still load.

Signal Baseline Window Source Rule
docs.page.load with page_type:api and environment:production 0.55-0.58 TPM. 830 events in 24h. 5524 events in 7d. 2026-10-06T19:03:55Z to 2026-10-07T19:03:55Z. 7d window 2026-09-30T19:03:55Z to 2026-10-07T19:03:55Z. Sentry metrics, org sentry, project docs Hold this TPM band. Absent if the 24h count falls toward 0 while total docs.page.load stays near 12.9 TPM.
Total docs.page.load with environment:production 12.9 TPM. 18534 events in 24h. 2026-10-06T19:03:55Z to 2026-10-07T19:03:55Z Sentry metrics, org sentry, project docs Use this as the traffic denominator. Do not treat a site-wide traffic drop as a failed pin.

Regression watch

This pin regenerates every API reference page at build time. Slug drift shows as not-found on API paths. Render faults show as client errors.

Signal Baseline Window Source Rule
docs.page.not_found with environment:production, path api/alerts 8 events in 24h. No other api/ path in the top ten 404 paths. 2026-10-06T19:03:55Z to 2026-10-07T19:03:55Z Sentry metrics, org sentry, project docs Hold. Detected if api/ paths rise through the top 404 list or api/alerts moves well above 8 in 24h.
Error events with environment:production 144 events in 24h. 0.78 errors per 100 docs.page.load events against 18534 loads. 2026-10-06T19:03:55Z to 2026-10-07T19:03:55Z Sentry errors, org sentry, project docs Hold this ratio. Detected if error events rise while page loads hold.
Error events whose title or culprit mentions api, ApiPage, or OpenAPI 0 events in 24h 2026-10-06T19:03:55Z to 2026-10-07T19:03:55Z Sentry errors, org sentry, project docs Stay at zero. Detected if any such event appears.
Error events with environment:production 35 events in 24h 2026-10-06T19:03:55Z to 2026-10-07T19:03:55Z Sentry errors, org sentry, project develop-docs Hold. Detected if the 24h count rises while this service ships the shared page module.

If API not-found counts rise, inspect generated slugs under /api/{category}/{endpoint}. If docs client errors rise, inspect API page render in the catch-all route.

Not observable

Pageload traces with an /api/ transaction filter returned zero. API page-load metrics still counted 830 in the same window. The catch-all route likely names transactions without the URL path. Hourly variance for API page loads was not measured. The schema pin is not a production telemetry field. Endpoint body text has no checksum signal. develop-docs has no generated API catalog to confirm.

solnic pushed a commit that referenced this pull request Oct 8, 2026
Co-authored-by: sentry-api-schema-updater[bot] <271575301+sentry-api-schema-updater[bot]@users.noreply.github.com>

This branch was successfully deployed

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