Skip to content

Bump API schema to 0430d19e - #20219

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

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

Copy link
Copy Markdown
Contributor

The plan checks the Replay field list, API 404s, API page loads, and client errors. An issue escalates when API 404s or errors rise. An issue also escalates when the two removed field names still appear after deploy.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

The Replay API docs drop info_ids and warning_ids from the field query choices. This effect is live after sentry-docs deploys to production. develop-docs also ships the shared source file. develop-docs does not render these OpenAPI pages.

The two pages are /api/replays/list-an-organizations-replays/ and /api/replays/retrieve-a-replay-instance/.

Risk

A bad OpenAPI schema can break API page generation at build time. Users then see 404s on API docs pages. All API docs pages share this build path. develop-docs does not fetch this schema at runtime.

Intended effect

The new behavior is the shorter field list on those two Replay API docs pages. Confirm by fetching those pages after sentry-docs production is live. absent means those two names still appear, or the pages return 404.

Signal Baseline Rule Source
Replay field choices on the list page and the retrieve page Both pages list info_ids and warning_ids Those two names are gone GET https://docs.sentry.io/api/replays/list-an-organizations-replays/ and GET https://docs.sentry.io/api/replays/retrieve-a-replay-instance/. Sampled 2026-10-23T22:15Z.

Regression watch

This diff rebuilds every API docs page from the schema. Watch 404s and errors on that /api/ family. Also watch API page load volume. Watch develop-docs errors because that ship also deploys the shared source.

If the fleet error count rises, split by /api/ and by api/replays. Last 24h had 10 errors on /api/ URLs. Last 24h had no docs.page.not_found for api/replays.

Signal Baseline Rule Source
API docs 404s docs.page.not_found with requested_path:api* 10 events and 836 API page loads, 1.2%, in 2026-10-22T22:15Z/2026-10-23T22:15Z Hold as a share of API page loads Sentry sentry/docs, environment:production
sentry-docs production errors 0-40 events per hour. 293 events in 2026-10-22T22:15Z/2026-10-23T22:15Z. 265 events in 2026-10-21T23:00Z/2026-10-22T22:00Z Hold in 0-40 per hour Sentry sentry/docs, environment:production
API page loads docs.page.load with page_type:api 8-74 events per hour. 836 events in 2026-10-22T22:15Z/2026-10-23T22:15Z. About 773 events in 2026-10-21T23:00Z/2026-10-22T22:00Z Hold in 8-74 per hour Sentry sentry/docs, environment:production
develop-docs production errors 0-16 events per hour. 45 events in 2026-10-22T22:15Z/2026-10-23T22:15Z. About 28 events in 2026-10-21T23:00Z/2026-10-22T22:00Z Hold in 0-16 per hour Sentry sentry/develop-docs, environment:production

Not observable

The prior-day API 404 timeseries is missing. That 48h query timed out.

Replay page load volume is too sparse for a rate rule. docs.page.load on /api/replays* was 5 events in 2026-10-22T22:15Z/2026-10-23T22:15Z. The list page had 1 event. The retrieve page had 0 events.

@cursor

cursor Bot commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The two Replay API pages still omit the old field names.

This branch was successfully deployed

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