Skip to content

Bump API schema to 8753a857 - #19868

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit b1be63b into master Oct 8, 2026
0 of 2 checks passed
@vercel

vercel Bot commented Oct 8, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Building Building Preview Oct 8, 2026 7:38pm UTC
sentry-docs Building Building Preview Oct 8, 2026 7:38pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-8753a857 branch October 8, 2026 19:38
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 8, 2026
@github-actions

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

Copy link
Copy Markdown
Contributor

The change pins a new OpenAPI schema SHA at build time. API reference pages rebuild from that file. The plan checks API page loads, API not-found counts, and client errors. An issue escalates when API pages stop loading or those errors rise.

Monitoring in production

Services: sentry-docs, develop-docs.

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

Plan

What changed

The API docs build now fetches OpenAPI schema 8753a857 instead of f73faaac. User requests to API pages then receive pages built from that schema. The published OpenAPI JSON is the same at both SHAs. Only ownership stats changed in the schema repository.

sentry-docs must deploy before API pages go live. develop-docs also deploys. Vercel skip-build rebuilds every src/ change, and the catalog says src/ ships to both. API pages exist only on sentry-docs.

Risk

A bad schema fetch or parse can fail the sentry-docs build or drop API routes. Users then see not-found pages on API paths. The shared src/ rebuild can also break develop-docs.

Intended effect

The schema SHA is not visible in telemetry. The OpenAPI JSON did not change, so no new page appears. Success is that API pages keep rendering after the rebuild.

absent looks like API page loads falling to zero while other page loads continue.

Signal Baseline Rule Source
API page loads 4-92 per hour. 939 in 24h. 4.7% of 20119 site page loads Hold the hourly band. absent if the rate falls to 0 while site page loads hold Sentry org sentry project docs. Metric docs.page.load. Query metric.name:docs.page.load AND page_type:api AND environment:production. Window 2026-10-07T19:38:59Z to 2026-10-08T19:38:59Z

Regression watch

This rebuild can drop API routes or ship a bad shared client bundle. Watch API not-found counts and client errors on both deploys.

Signal Baseline Rule Source
API not-found 0-19 per hour. 30 in 24h. 3.2% of 939 API page loads Hold the hourly band. Escalate if the count rises above 19 per hour Sentry org sentry project docs. Metric docs.page.not_found. Query metric.name:docs.page.not_found AND requested_path:api* AND environment:production. Window 2026-10-07T19:38:59Z to 2026-10-08T19:38:59Z
docs client errors 0-14 per hour. 100 in 24h. 0.50% of 20119 page loads. TypeError 68, NotFoundError 12 Hold the hourly band. Escalate if the count rises above 14 per hour or the 24h ratio rises above 0.50% Sentry org sentry project docs. Errors query environment:production. Window 2026-10-07T19:38:59Z to 2026-10-08T19:38:59Z
develop-docs client errors 0-9 per hour. 23 in 24h. 1.4% of 1687 page loads Hold the hourly band. Escalate if the count rises above 9 per hour or the 24h ratio rises above 1.4% Sentry org sentry project develop-docs. Errors query environment:production. Window 2026-10-07T19:38:59Z to 2026-10-08T19:38:59Z

If API not-found counts rise, inspect missing API slugs. If develop-docs errors rise without API not-found movement, inspect the shared client bundle.

Not observable

API pageload latency. One trace search for /api/ pageload spans returned no rows. The schema SHA itself is not a runtime field.

@cursor

cursor Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages kept loading after this ship.
  • API pages kept loading for the first hour after this ship.
  • API pages kept loading for 24 hours after this ship.
  • API pages kept loading three days after this ship.

This branch was successfully deployed

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