Skip to content

Bump API schema to 3cdad034 - #20114

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 24bf5ea into master Oct 20, 2026
14 of 16 checks passed
@vercel

vercel Bot commented Oct 20, 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 20, 2026 5:31pm UTC
sentry-docs Building Building Preview Oct 20, 2026 5:31pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-3cdad034 branch October 20, 2026 17:31
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 20, 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 20, 2026 •

Copy link
Copy Markdown
Contributor

API reference pages now build from a new OpenAPI schema. The plan checks API page loads and API 404s. An issue escalates when API page loads fall or API 404s rise.

Services: sentry-docs.

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

Plan

What changed

The site now builds API reference pages from OpenAPI schema 3cdad034. Requests to API category and endpoint pages now serve that schema. The schema patch added content and did not remove paths. sentry-docs must deploy before this change is live. develop-docs shares source files but does not fetch this schema at build time.

Risk

A bad schema can fail the production build. The site then stays on the previous schema. A changed operation title can change a page slug. That existing API page then returns 404. A new schema field can crash the API page renderer. Users then see an error page on that endpoint. This deploy also ships every other docs page. A failed build blocks the whole site.

Intended effect

API page loads after deploy show the rebuilt reference pages are reachable. This change does not add a new metric. A modest rise can occur if new endpoints get traffic. That still confirms the rebuild. Absent looks like the API page load rate falling near zero.

Signal Baseline Window Comparison Source
docs.page.load with page_type=api and environment=production 0.48-0.55 events per minute 2026-10-18T17:32:25Z to 2026-10-20T17:32:25Z hold in this band Sentry org sentry project docs. Query: metric.name:docs.page.load AND page_type:api AND environment:production

Last 24h counted 793 events. The prior 24h counted 693 events.

Regression watch

A slug change would raise API 404s against stable API page load volume. These 404s already cluster on guessed paths such as api/alerts. A broken deploy would raise production errors on the docs project.

Signal Baseline Window Comparison Source
docs.page.not_found with requested_path=api* and environment=production 1.7-2.0 404s per 100 API page loads. 14 events per 24h in both sampled days 2026-10-18T17:32:25Z to 2026-10-20T17:32:25Z hold in this band Sentry org sentry project docs. Query: metric.name:docs.page.not_found AND requested_path:api* AND environment:production
production error events on project docs 0.11-0.14 errors per minute. 153 events in the last 24h and 195 in the prior 24h 2026-10-18T17:32:25Z to 2026-10-20T17:32:25Z hold in this band Sentry org sentry project docs. Query: environment:production

If the 404 share rises, check slugify output for changed operation names. If errors rise across the project, the shared Next.js deploy may be broken.

Not observable

API-sliced error events returned zero with url.path and transaction filters. Those filters likely miss client errors on the catch-all route. API pageload p95 was 5591ms in the last 24 hours. The 48 hour query timed out, so this plan has no prior-day latency band. The new endpoint slugs in schema 3cdad034 were not listed in the patch fetch. Traffic to brand new API pages is not a confirmed signal.

inventarSarah pushed a commit that referenced this pull request Oct 21, 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 — 162a939d Deployed Oct 20, 2026 by vercel[bot]
Preview – develop-docs — 162a939d Deployed Oct 20, 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