Skip to content

Bump API schema to 969e159e - #20181

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit fdf3c08 into master Oct 22, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-969e159e branch October 22, 2026 17:06
@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 field lists, API page loads, API docs 404s, and API docs client errors. An issue escalates when those pages 404, those errors rise, or the new field names stay missing.

Monitoring in production

Services: sentry-docs.

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

Plan

What changed

The OpenAPI schema pin now points at SHA 969e159e. The List and Retrieve Replays API docs pages now list ota_updates and replay_type in the field query parameter. This is live after a production deploy of sentry-docs. develop-docs shares this source file but does not render OpenAPI pages.

Risk

A broken schema can fail the docs build or leave API pages empty. A slug change can 404 old API URLs. This patch only adds two field names, so slug changes are unlikely. Wrong field docs lead API users to send invalid field values.

Intended effect

Telemetry does not record the new field names. Confirm the names on the live pages after deploy. Absent looks like those pages still load while the field list still omits ota_updates and replay_type.

The schema patch updates the same enum on both operations. The list page was fetched before ship. The retrieve page was not fetched.

Signal Baseline Rule Source
field choices on List an Organization's Replays ota_updates and replay_type are absent Both names must appear after deploy Live page https://docs.sentry.io/api/replays/list-an-organizations-replays/ at 2026-10-22T17:07:08Z
field choices on Retrieve a Replay Instance Same enum in the schema patch. Live retrieve HTML was not read Both names must appear after deploy Schema commit 969e159e. Page https://docs.sentry.io/api/replays/retrieve-a-replay-instance/

Replay API page loads show that those pages still render. They do not prove the new names. That volume belongs in Regression watch.

Regression watch

Watch the Replay pages and the rest of the API docs tree. All API pages come from the same schema fetch. Traces for users are sampled at 30%.

Windows: last 24h is 2026-10-21T17:07:08Z to 2026-10-22T17:07:08Z. Prior 24h is 2026-10-20T17:07:08Z to 2026-10-21T17:07:08Z. Project is Sentry sentry/docs in production.

Signal Baseline Rule Source
Client errors on http.url:*docs.sentry.io/api/* 5 events in the last 24h. Rate 0.6% of 869 API page loads Detected if the rate rises above 1.2% while API page loads hold Sentry errors, last 24h. Prior 24h with this same url field was not measured
docs.page.not_found with requested_path:api/replays 0 in the last 24h and in the last 48h Hold at 0 Sentry metrics, production
docs.page.not_found with requested_path:api* as a share of API page loads Last 24h: 20 404s and 869 loads, share 2.2%. Prior 24h: about 13 404s and 790 loads, share 1.6% Detected if the share rises above 2.3% while loads hold Sentry metrics docs.page.not_found and docs.page.load page_type:api
docs.page.load page_type:api Last 24h 869. Prior 24h 790. Band 790-869 per 24h Hold in that band. A drop toward 0 with rising API 404s means the schema tree failed Sentry metrics, production
docs.page.load page_type:api api_category:replays Last 24h 12. Prior 24h about 13. Band 12-14 per 24h Sparse. Detected if this falls to 0 while other API categories still load Sentry metrics, production

Known noise: api/alerts already 404s at 9 events in the last 24h. Do not treat that path alone as this change.

Not observable

Sentry metrics do not record OpenAPI enum text. If the live Replay pages cannot be fetched, mark intended effect unknown.

The prior 24h client-error count was not measured with http.url:*docs.sentry.io/api/*. A 48h count of 20 used a different url field.

Replay pageload p95 was 554ms from only 7 sampled spans in the last 24h. That sample is too small for a rule.

@cursor

cursor Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The live Replay API pages still list both new field names.

This branch was successfully deployed

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