Skip to content

Bump API schema to f45d69fe - #20164

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 269bae7 into master Oct 22, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-f45d69fe branch October 22, 2026 07:43
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 22, 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 22, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks OpenAPI catalog page loads, API not-found rate, and errors on API pages. An issue escalates when those catalog pages stop loading or the error rate rises.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The production build now fetches the OpenAPI document at SHA f45d69fef3d4e16a9fcd9b53385629596425ce63. That schema commit did not change openapi-derefed.json. API catalog pages should match the prior pin. sentry-docs must deploy before those catalog pages go live. develop-docs also deploys this shared source file. The Vercel production reporter maps this repository to both services. Catalog pages render only on sentry-docs.

Risk

A broken OpenAPI document can drop category and endpoint pages from static generation. Readers then see 404 pages on those catalog URLs. Changed slugs also break saved links. The shared page module could fail both production deploys if it throws at import. The consumed OpenAPI file did not change, so that content risk is low.

Intended effect

This pin does not add a new counter. The new schema commit did not change the OpenAPI document the site fetches. Confirm that OpenAPI-backed catalog pages still load. Absent looks like that load count falling toward zero while other pages still load. A develop-docs deploy cannot show this catalog. Record intended effect unknown on that ship.

Signal Baseline Window Rule Source
docs.page.load with api_category set 390-430 loads per 24h 2026-10-20T07:44:00Z to 2026-10-22T07:44:00Z Hold in this band. Absent if the count falls toward 0 while other docs pages still load. Sentry sentry/docs. Query: metric.name:docs.page.load AND metric.type:counter AND has:api_category AND sentry.environment:production. Aggregate: count(value). Last 24h 390. Prior 24h 430.

Regression watch

A bad schema drops catalog pages and raises 404s and page errors. Watch the API path, not fleet health. Put each risk on these signals.

Signal Baseline Window Rule Source
API not-found share 1.7-2.2% of API page loads 2026-10-20T07:44:00Z to 2026-10-22T07:44:00Z Hold in this band. Detected if the share rises above 2.2%. Sentry sentry/docs. Numerator: metric.name:docs.page.not_found AND requested_path:api* AND sentry.environment:production, count 14 then 17. Denominator: metric.name:docs.page.load AND metric.type:counter AND page_type:api AND sentry.environment:production, count 840 then 767.
Error events on API URLs 0.6-1.7% of API page loads 2026-10-20T07:44:00Z to 2026-10-22T07:44:00Z Hold in this band. Detected if the share rises above 1.7%. Sentry sentry/docs. Query: environment:production AND (transaction:"/api/" OR url:"/api/"). Count 5 then 13 against the same page_type:api denominator.
Pageload and navigation failure rate on /api/ 3.8% in the last 24h. 8.6% over 7d 2026-10-21T07:44:00Z to 2026-10-22T07:44:00Z and 2026-10-15T07:44:00Z to 2026-10-22T07:44:00Z Hold near 3.8%. Detected if the 24h rate rises above 8.6%. The 7d pool includes a 2026-10-18 spike. Sentry sentry/docs. Query: span.op:[pageload,navigation] AND url.path:/api/* AND sentry.environment:production. Fields: failure_rate(), count(), p95(span.duration). Last 24h count 607 and p95 7582ms. 7d count 4020 and p95 5432ms. Traces sample at 30%.
develop-docs production errors 33-37 errors per 24h 2026-10-20T07:44:00Z to 2026-10-22T07:44:00Z Hold in this band. Detected if the count rises above 37 with no traffic drop. Sentry sentry/develop-docs. Query: environment:production. Aggregate: count(). Last 24h 37. Prior 24h 33.

If the not-found share rises, inspect dropped category slugs and endpoint slugs. If API URL errors rise, inspect client exceptions on those catalog pages.

Not observable

The live pages do not expose the schema SHA. Browser LCP for /api/ pageloads returned no rows. A separate traces window for the prior day was not measured.

This branch was successfully deployed

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