Skip to content

Bump API schema to f8158928 - #20183

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit c05fd10 into master Oct 22, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-f8158928 branch October 22, 2026 17:20
@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

Generated API reference pages rebuild from a newer schema. Two endpoint pages drop two field names from a query parameter list. An issue escalates when those pages 404 or client errors appear on them.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The List an Organization's Replays page omits ota_updates and replay_type from field choices. The Retrieve a Replay Instance page makes the same field-list change.

sentry-docs must deploy before this is live. develop-docs also deploys because the shared resolver file changed. develop-docs does not render these OpenAPI pages.

Risk

A bad schema can fail the docs production build. A render failure can 404 the two Replay API pages. The shared bundle can raise client errors on developer docs after rebuild.

Intended effect

The field lists no longer include ota_updates or replay_type. Sentry metrics do not record that page text. Use page-load counts on those two endpoints as a reachability proxy. absent means those two endpoint counts stay at zero after deploy while other API page loads hold.

Traffic on these two pages is sparse. A quiet 24h after deploy is not proof the field list changed.

Signal Baseline Window Rule Source
docs.page.load for api_endpoint list-an-organizations-replays 3 loads / 24h. Share of API page loads is 3/867 = 0.3%. 2026-10-21T17:20:00Z to 2026-10-22T17:20:59Z Stay above 0. absent if this stays 0 while API page_type loads hold. Sentry sentry/docs. Query: metric.name:docs.page.load AND sentry.environment:production AND api_category:replays. Group by api_endpoint.
docs.page.load for api_endpoint retrieve-a-replay-instance 2 loads / 24h. Share of API page loads is 2/867 = 0.2%. 2026-10-21T17:20:00Z to 2026-10-22T17:20:59Z Stay above 0. absent if this stays 0 while API page_type loads hold. Same metric and group as the row above.

Regression watch

This diff can drop the two Replay API pages or break the shared API page render. It can also ship a new bundle to developer docs.

API page_type loads may vary by weekday. This window covers Wednesday and Thursday hours only.

Signal Baseline Window Rule Source
docs.page.not_found for requested_path api/replays 0 / 24h. This path was absent from the top 25 requested_path groups. Lowest shown group was 1. 2026-10-21T17:20:00Z to 2026-10-22T17:20:59Z Hold at 0. A new api/replays 404 is a regression. Sentry sentry/docs. Query: metric.name:docs.page.not_found AND sentry.environment:production. Group by requested_path.
Error events with http.url matching /api/replays/ 0 errors / 24h. Replay page loads in the same window were 12. Error share is 0/12 = 0%. 2026-10-21T17:20:00Z to 2026-10-22T17:20:59Z Hold at 0. Any new error on these URLs is a regression. Sentry sentry/docs. Query: environment:production http.url:/api/replays/.
docs.page.not_found for requested_path starting with api 20 / 24h. API page loads were 867. 404 share is 20/(867+20) = 2.3%. 2026-10-21T17:20:00Z to 2026-10-22T17:20:59Z Hold in 1.5-3.5% of API-path requests. Rise above 3.5% is a regression if API page loads also fall. Sentry sentry/docs. Query: metric.name:docs.page.not_found AND sentry.environment:production AND requested_path:api*. Pair with docs.page.load page_type:api at 867 / 24h.
Error events on sentry/develop-docs 29 errors / 24h. 2026-10-21T17:20:00Z to 2026-10-22T17:20:59Z Stay under 60 / 24h. A doubling is a regression. Page-load volume for this project was not measured. Sentry sentry/develop-docs. Query: environment:production.

If Replay 404s or Replay URL errors rise, inspect the two endpoint pages and the API category page.

Not observable

The field-list text on the two pages is not in telemetry. The executor cannot confirm the enum change from Sentry.

Hourly shape for these signals was not sampled. The bands above come from one 24h total.

The exact fleet total for docs.page.not_found was not measured. A grouped top-25 query timed out on retry.

Page-load volume for develop-docs was not measured. The 29-error watch has no traffic denominator.

This branch was successfully deployed

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