Skip to content

Bump API schema to 097c4399 - #20280

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 27, 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 27, 2026 11:05pm UTC
sentry-docs Ready Ready Preview Oct 27, 2026 11:05pm UTC

Request Review

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

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API-path 404s, and errors on those pages. An issue escalates when API pages stop loading or those 404s rise. The pin does not change the OpenAPI page bodies.

Services: sentry-docs.

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

Plan

What changed

API reference pages now build from OpenAPI pin 097c4399. That pin adds an idempotent field to an operations catalog. This site does not read that catalog. The OpenAPI file that feeds the pages did not change.

sentry-docs must deploy before the pin is live. Runtime metrics use Sentry project docs. develop-docs also builds this commit because src/ is shared. It does not fetch the schema and does not generate those pages, so it is not in services.

Risk

A bad pin can omit API pages from the static build. Readers then get 404s on /api/ category and endpoint URLs. A slug rewrite 404s old links. Page bodies did not change, so new render faults are unlikely. Search widgets on those pages can still fail as they do today.

Intended effect

API reference pages keep loading after the pin. The page_type api share of docs.page.load must hold in band. absent: other page types keep loading and the api share falls near 0.

Check Baseline Rule Source
docs.page.load share with page_type api 4.1% (796 of 19459) in 2026-10-26T22:59:00Z to 2026-10-27T22:59:00Z. 5.7% (1078 of 18800) in 2026-10-25T22:59:00Z to 2026-10-26T22:59:00Z. Band 4.1-5.7%. Hold in band. The pin does not add pages. Sentry metrics, project docs, counter docs.page.load, query page_type:api environment:production versus all production docs.page.load

Regression watch

A dropped or renamed endpoint 404s the old URL. A thrown API page shows as an error on that URL. Put each Risk item on these checks.

Check Baseline Rule Source
docs.page.not_found rate on requested_path api* versus page_type api loads 1.5% (12 of 796) in 2026-10-26T22:59:00Z to 2026-10-27T22:59:00Z. 0.65% (7 of 1078) in 2026-10-25T22:59:00Z to 2026-10-26T22:59:00Z. Band 0.65-1.5%. Hold in band. Escalate if the rate rises above 1.5%. Sentry metrics, project docs, counter docs.page.not_found, query requested_path:api* environment:production
Error events with http.url /api/ versus page_type api loads 0.38% (3 of 796) in 2026-10-26T22:59:00Z to 2026-10-27T22:59:00Z. About 0.3% (about 3 of 1078) in the prior 24h. Band 0.3-0.38%. Those three events were third-party fetch faults, not page render faults. Hold in band. Escalate if the rate rises above 1% or new render titles appear. Sentry errors, project docs, query environment:production http.url:/api/

Not observable

The prior 24h p95 for API pageloads was not retrieved. The 24h query for span.op pageload,navigation and url.full /api/ returned 667 spans and p95 8141ms in 2026-10-26T22:59:00Z to 2026-10-27T22:59:00Z. Traces are sampled at 30%. The 2d follow-up timed out. Do not treat API latency as confirmed or as a regression without that prior window.

The idempotent catalog field is not rendered on these pages. There is no check that it appears.

This branch was successfully deployed

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