Skip to content

Bump API schema to 81b0732b - #20046

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 09642c2 into master Oct 16, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-81b0732b branch October 16, 2026 22:28
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 16, 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 16, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API not-found events, and client errors on API pages. An issue escalates when API page loads fall or not-found events rise.

Services: sentry-docs.

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

Plan

What changed

The API reference build now fetches OpenAPI schema SHA 81b0732b. Requests to API reference pages still render the same spec. The OpenAPI document did not change from the prior SHA. sentry-docs must deploy before this change is live. API reference pages are generated only for that Vercel project. develop-docs ships the shared file but does not generate those pages.

Risk

A bad schema can omit API pages from the static build. Users then see not-found on former API URLs. A render break shows as client errors on those pages. The blast radius is the API reference tree. Other pages do not read this schema at runtime. A failed schema fetch fails the docs build and blocks deploy.

Intended effect

API page loads must continue after the rebuild. The spec content is unchanged, so the share should hold. absent looks like the API share falling while other page loads hold.

Signal Baseline Rule Source
API share of docs.page.load 4.7% in both sampled days. 743 of 15735 loads in 2026-10-15T22:28Z to 2026-10-16T22:28Z. 922 of 19417 loads in 2026-10-14T22:28Z to 2026-10-15T22:28Z. Hold in 4.5-5.0%. absent if the share falls below 3.0% while total page loads hold. Sentry project docs. Metric docs.page.load. Filter page_type:api and environment:production versus all production page loads.

Regression watch

This diff can drop or rename API pages and break those URLs. Watch not-found events and client errors on the API path. Most current API not-found events are already on api/alerts.

Signal Baseline Rule Source
API not-found rate 1.2% and 0.4% of API page loads. 9 not-found events with 743 API loads in 2026-10-15T22:28Z to 2026-10-16T22:28Z. 4 not-found events with 922 API loads in 2026-10-14T22:28Z to 2026-10-15T22:28Z. api/alerts had 6 of the 9 later-day events. Hold in 0.4-1.3% of API page loads. detected if the rate rises above 2.0%. Sentry project docs. Metric docs.page.not_found. Filter requested_path:api* and environment:production. Divide by docs.page.load with page_type:api.
Client errors on API pages 0.40% and 0.22% of API page loads. 3 errors in 2026-10-15T22:28Z to 2026-10-16T22:28Z. 2 errors in 2026-10-14T22:28Z to 2026-10-15T22:28Z. Titles were kapa and Algolia fetch failures. Hold in 0.2-0.5% of API page loads. detected if the rate rises above 1.0% or new render titles appear. Sentry project docs. Error events. Filter environment:production and transaction or url matching /api/.

Not observable

Production metrics do not show the GitHub schema fetch during build. Metrics do not show whether page text matches the OpenAPI document. Pageload traces do not match API paths reliably.

This branch was successfully deployed

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