Skip to content

Bump API schema to 1e28b570 - #20261

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

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

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 4:06pm UTC
sentry-docs Ready Ready Preview Oct 27, 2026 4:06pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 13b379c into master Oct 27, 2026
14 of 16 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-1e28b570 branch October 27, 2026 16:00
@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 build pins a newer OpenAPI schema. The schema document itself did not change. The plan checks API page loads, API 404s, and failed API page spans. An issue escalates when API 404s jump or those failed page spans appear.

Rollout complete

Services: sentry-docs.

Plan

What changed

The production build fetches OpenAPI JSON from schema SHA 1e28b570.
The previous pin was 5c02c32.
The OpenAPI document did not change between those commits.
Requests to /api/ category and endpoint pages should keep the same content.
sentry-docs must deploy before this pin is live.
Vercel project sentry-docs reports that ship.
develop-docs also builds this shared src file.
It does not render generated API reference pages.
This plan does not watch develop-docs.

Risk

A missing or invalid schema file fails the production build.
Users never see that failure.
If the fetched document later diverges, old endpoint slugs can 404.
A much larger schema can slow API page loads.

Intended effect

The schema document did not change.
No new endpoint page is expected.
API page loads at the baseline share show the pin still builds those pages.
Absent: that share falls toward 0 while other docs pages still load.

Signal Baseline Rule Source
Share of docs.page.load with page_type:api among all docs.page.load, sentry.environment:production 4.0% in 2026-10-26T16:00:00Z to 2026-10-27T16:00:00Z. That is 771 of 19174 page loads. 5.8% in 2026-10-25T16:00:00Z to 2026-10-26T16:00:00Z. That is 966 of 16760 page loads. Band 4.0-5.8%. Hold in the 4.0-5.8% band. Absent if the share falls toward 0 while other docs page loads continue. Sentry org sentry, project docs. API count query: metric.name:docs.page.load AND page_type:api AND sentry.environment:production. All-pages query: metric.name:docs.page.load AND sentry.environment:production.

Regression watch

A bad pin can 404 old API pages or fail those page spans.
Watch the signals below.
Existing client errors on this path are search and browser-extension fetch noise.
Do not treat those two issues as this change.

Signal Baseline Rule Source
docs.page.not_found with requested_path:api*, as a share of API page loads plus those 404s, sentry.environment:production 1.5% in 2026-10-26T16:00:00Z to 2026-10-27T16:00:00Z. That is 12 404s over 771+12 API-path events. 0.5% in 2026-10-25T16:00:00Z to 2026-10-26T16:00:00Z. That is 5 404s over 966+5 events. Band 0.5-1.5%. Paths in the 48h window were guessed slugs such as api/alerts and api/prevent. Hold in the 0.5-1.5% band. Detected if the share rises above that band, or if 404s appear on former valid endpoint slugs. Sentry org sentry, project docs. Query: metric docs.page.not_found with sentry.environment:production requested_path:api*. Pair with the API docs.page.load count above.
Failed /api/ page spans, span.op:[pageload,navigation], url.path:/api/*, span.status_code:5* or span.status:internal_error, sentry.environment:production 0 spans in 2026-10-26T16:00:00Z to 2026-10-27T16:00:00Z, over 680 sampled /api/ pageload and navigation spans. Hold at 0. Detected if any 5xx or internal_error page span appears on /api/. Sentry org sentry, project docs. Query: span.op:[pageload,navigation] url.path:/api/* (span.status_code:5* OR span.status:internal_error) sentry.environment:production.
Error events on /api/ URLs or transactions, environment:production 0.26% of API page loads in 2026-10-26T16:00:00Z to 2026-10-27T16:00:00Z. That is 2 errors over 771 API page loads. 0.21% in 2026-10-25T16:00:00Z to 2026-10-26T16:00:00Z. That is 2 errors over 966 API page loads. Band 0.21-0.26%. The two events in the latest 24h were DOCS-BDZ TypeError: Failed to fetch (insights.algolia.io) and DOCS-6QX TypeError: Failed to fetch (cdn.shopimgs.com). Hold in the 0.21-0.26% band. Detected if the rate rises above that band, or if new API-page errors appear besides those two issues. Sentry org sentry, project docs. Query: environment:production (http.url:*/api/* OR transaction:*/api/*).

Not observable

The live schema SHA is not emitted at runtime.
Rendered API page HTML is not compared to the prior schema.
Prior-day p95 for /api/ pageloads was not measured.
The 48-hour traces query timed out.

@cursor

cursor Bot commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages kept loading at the usual share, and API 404s did not jump.

This branch was successfully deployed

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