Skip to content

Bump API schema to 4973d6c8 - #20175

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

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

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 12:54pm UTC
sentry-docs Ready Ready Preview Oct 22, 2026 12:54pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 9865bc4 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-4973d6c8 branch October 22, 2026 12:48
@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 change pins the generated API reference to a new schema revision.
  • REST reference pages are expected to keep the same content.
  • Watch API page loads, API 404s, and client errors. Escalate when loads fall or 404s and errors rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

Public REST API pages now build from schema SHA 4973d6c8. The REST OpenAPI payload is unchanged.

sentry-docs must deploy before the public API pages go live. develop-docs also deploys this commit because it shares src/.

Risk

A missing or unreadable OpenAPI file can omit API pages from the static build. Readers then hit 404s on API category and endpoint URLs. A broken API page can throw client errors on those URLs. The shared rebuild can also ship a bad client bundle on develop-docs.

Intended effect

API page loads should hold. The schema commit did not change openapi-derefed.json. Absent means API loads fall toward zero while other page types hold.

Signal Baseline Window Rule Source
API docs.page.load 853 loads, 4.6% of 18709 page loads 2026-10-21T12:48:00Z to 2026-10-22T12:48:00Z Hold in 787-853 loads per 24h. Expected shift is none. Sentry org sentry project docs, production, metric.name:docs.page.load page_type:api

The prior 24h window 2026-10-20T12:48:00Z to 2026-10-21T12:48:00Z counted 787 API page loads. Use the 24h pooled value. Hourly API loads ranged from 8 to 96 and can hide a drop in a short slice.

Regression watch

Watch API 404s and client errors on API URLs. Also watch client errors after the shared develop-docs rebuild.

Signal Baseline Window Rule Source
API docs.page.not_found 16 counts, 1.8% of 869 API results 2026-10-21T12:48:00Z to 2026-10-22T12:48:00Z Hold in 1.8-1.9% of API results. Detected if the share rises above 4% or the 24h count doubles. Sentry org sentry project docs, production, metric.name:docs.page.not_found requested_path:api*
Production errors on /api/ URLs 8 events, 0.9% of 853 API loads 2026-10-21T12:48:00Z to 2026-10-22T12:48:00Z Hold near 0.9% of API loads. Detected if this share rises while API loads hold. Sentry org sentry project docs, production, environment:production url:*/api/*
develop-docs production errors 32 events 2026-10-21T12:48:00Z to 2026-10-22T12:48:00Z Hold in 29-32 events per 24h. Detected if the 24h count doubles. Sentry org sentry project develop-docs, production

The prior 24h window counted 15 API 404s, 1.9% of 802 API results. Hourly API 404s were usually 0-5, with one hour at 7. The prior 24h develop-docs error count was 29. If API 404s rise, check whether whole API categories disappeared from the sidebar.

Not observable

Pageload duration and LCP for /api/ URLs did not return rows. Traces use the catch-all /:path*? transaction, and a URL filter returned zero. There is no production signal for the schema SHA itself. The schema commit only changed rpc_method_schema.json, which this build does not fetch, so no new endpoint page can confirm the pin. The prior 24h error count on /api/ URLs was not measured. develop-docs page-load volume was not measured, so that error count has no denominator.

This branch was successfully deployed

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