Skip to content

Bump API schema to 2da92393 - #20168

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

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

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 9:00am UTC
sentry-docs Error Error Oct 22, 2026 9:00am UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 92ea675 into master Oct 22, 2026
15 of 17 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-2da92393 branch October 22, 2026 08:57
@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 API reference page loads, API 404s, and client errors. An issue escalates when API 404s rise or API reference page loads fall.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The build now pins the public API schema to 2da92393a8df8d787586395181346cd56b59a84b. API reference pages render from that schema at build time. The OpenAPI document in that schema commit did not change. sentry-docs must deploy before those pages go live. develop-docs also ships this src commit. The catalog and the Vercel deploy reporter both name that second ship. develop-docs does not fetch the schema and does not serve those pages.

Risk

A broken schema can drop API reference pages from the static build. Readers then see 404s on API category and endpoint URLs. A failed schema fetch can fail the sentry-docs production build. This pin did not change the OpenAPI file, so new endpoint text is unlikely. A failed deploy leaves the previous pin in production.

Intended effect

Schema-generated API reference pages must keep loading. The client counter with page_type api and api_category set is that proof. Absent looks like that counter falling toward zero while other page types still load. This pin did not change OpenAPI content, so the expected shift is none. The intended effect is visible only after sentry-docs deploys. A develop-docs-only ship cannot confirm it.

Signal Baseline Rule Source
Schema API page loads 407-420 loads per 24h. Share of all page loads is 2.2-2.4%. Hold in this band. Absent if the count falls toward 0 while other page types hold. Sentry org sentry, project docs. Metric docs.page.load. Query page_type:api AND has:api_category AND sentry.environment:production. Windows 2026-10-21T08:58:05Z to 2026-10-22T08:58:05Z and 2026-10-20T08:58:05Z to 2026-10-21T08:58:05Z.

Regression watch

A bad schema first shows as 404s on API URLs. Client errors and sibling page loads catch a wider docs break from the same ship.

Signal Baseline Rule Source
API 404 rate 1.7-2.1% of page_type api loads. Counts 14-17 404s per 24h over 796-833 api page loads. Hold in this band. Detected if the rate rises above 2.1%. Sentry org sentry, project docs. Metric docs.page.not_found with requested_path:api* versus docs.page.load with page_type:api. Same production windows as Intended effect.
Docs client error rate 1.14-1.34% of all page loads. Counts 199-247 errors per 24h over 17404-18493 page loads. Hold in this band. Detected if the rate rises above 1.34%. Sentry org sentry, project docs. Error events with environment:production. Same windows. All errors share transaction /:path*?. If this rate rises, compare the API 404 signal.
Platforms page loads 8420-9783 loads per 24h. Share of all page loads is 48-53%. This sibling volume moved across the two windows. Hold the share in this band. Detected if this path falls with schema API page loads. Sentry org sentry, project docs. Metric docs.page.load with page_type:platforms AND sentry.environment:production. Same windows.

Not observable

Pageload duration on /api/ paths. A count query for span.op:pageload and url.path:/api/* returned 393 in the later 24h window. A duration aggregate was not confirmed. Client errors cannot be split by URL because every error uses transaction /:path*?. develop-docs has no page-load volume in this plan, so its error count has no rate. Exact body text of each API endpoint has no content hash.

This branch had an error being deployed

1 failed and 1 active deployments
Preview – develop-docs — 262aa5a8 Deployed Oct 22, 2026 by vercel[bot]
Preview – sentry-docs — 262aa5a8 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