Skip to content

Bump API schema to 1f096498 - #20045

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 66f0fd9 into master Oct 16, 2026
14 of 16 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-1f096498 branch October 16, 2026 22:24
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 16, 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 16, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API not-found counts, and errors on API URLs. The plan also checks API pageload delay. An issue escalates when API pages stop loading or those errors rise.

Services: sentry-docs.

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

Plan

What changed

The docs build now fetches OpenAPI at schema SHA 1f096498. REST API reference pages rebuild from that OpenAPI file. The new schema commit only changes rpc_method_schema.json. This app does not read rpc_method_schema.json. The OpenAPI file is the same as SHA fc470a5b. Rendered API pages should match the prior schema.

The REST API pages go live when sentry-docs deploys. That pick is strong: the Vercel project, the deploy reporter, and the runtime Sentry project docs all agree. develop-docs shares this source file but does not render REST API pages.

Risk

A bad schema can drop API routes from the static build. Users then hit not-found pages for old API links. Broken schema data can crash API page render. This SHA does not change the OpenAPI file, so those breaks are unlikely. A failed fetch of the new SHA URL fails the production build. The shared catch-all page imports this resolver. A module load failure could affect every docs page.

Intended effect

API page loads with page_type api should continue after deploy. That is the new SHA serving the same OpenAPI pages. Absent means those loads fall toward zero while other page loads hold. There is no new-endpoint counter because OpenAPI did not change.

Signal Band Window Rule Source
API page load 729-742 loads per 24h 2026-10-15T22:24:50Z to 2026-10-16T22:24:50Z, and 7d mean from 2026-10-09T22:24:50Z to 2026-10-16T22:24:50Z Hold in this band. Absent is a drop toward zero while other page loads hold. Sentry metrics, project docs, docs.page.load, environment:production, page_type:api. Last 24h sum 742. 7d sum 5,100, mean 729 per day.
Other page load 14,987 loads per 24h 2026-10-15T22:24:50Z to 2026-10-16T22:24:50Z Use this only to decide absent. Other loads holding while API loads collapse means the API routes are gone. Sentry metrics, project docs, docs.page.load, environment:production. All types 15,729. API 742. Remainder 14,987.

Regression watch

This diff can hide API routes or break API page render. Watch not-found counts, API URL errors, pageload delay, and site errors. UTC day 2026-10-11 had 281 API URL errors and 11,240 site errors. Do not use that day as the normal band. Last 24h API URL errors are kapa and Algolia fetch failures. A schema break would add render errors on API URLs.

Signal Band Window Rule Source
API not-found 1.1-1.2 not-found per 100 API page loads, 8-9 not-found per 24h 2026-10-15T22:24:50Z to 2026-10-16T22:24:50Z, and 7d from 2026-10-09T22:24:50Z to 2026-10-16T22:24:50Z Hold in this band. A rise means dropped API routes or changed slugs. Sentry metrics, project docs, docs.page.not_found, environment:production, requested_path:api*. Last 24h sum 9 versus 742 API page loads. 7d sum 57 versus 5,100 API page loads.
API URL error 0.3-0.9 errors per 100 API page loads, 1-7 errors per 24h 2026-10-15T22:24:50Z to 2026-10-16T22:24:50Z, and quiet UTC days 2026-10-09 to 2026-10-15 except 2026-10-11 Hold in this band. A rise in render errors on API URLs is a regression. Sentry errors, project docs, environment:production, url https://docs.sentry.io/api*. Last 24h count 3 versus 742 API page loads. Quiet days 1-7. Exclude UTC 2026-10-11 count 281.
API pageload delay 6.8-9.4s p95 2026-10-15T22:24:50Z to 2026-10-16T22:24:50Z, and UTC days 2026-10-14 and 2026-10-15 Hold in this band. A rise above 9.4s may be slower API pages. UTC 2026-10-12 reached 14.3s, so delay is variable. Sentry traces, project docs, span.op:pageload, environment:production, http.url https://docs.sentry.io/api*. Last 24h p95 9.4s, n=320. UTC 2026-10-14 p95 6.8s. UTC 2026-10-15 p95 8.2s. Traces are sampled at 30%.
Site error 110-268 errors per 24h, 0.7 errors per 100 page loads in the last 24h 2026-10-15T22:24:50Z to 2026-10-16T22:24:50Z, and UTC days 2026-10-13 to 2026-10-15 Hold in this band. A rise with API URL errors means the shared page broke. Exclude UTC 2026-10-11 count 11,240. Sentry errors, project docs, environment:production. Last 24h count 110 versus 15,729 page loads. UTC 2026-10-13 count 162. UTC 2026-10-14 count 165. UTC 2026-10-15 count 268.

Not observable

No signal reports the HTML text of API pages. No signal reports the schema SHA in production. rpc_method_schema.json is not consumed, so its edit is not measurable here. Per-endpoint content changes cannot be confirmed in telemetry.

This branch was successfully deployed

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