Skip to content

Bump API schema to 4331a7d3 - #20147

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

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

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API not-found counts, and client errors on API URLs. An issue escalates when API pages stop loading or those not-found counts or errors rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

Generated API reference pages now fetch OpenAPI from schema commit 4331a7d3. That commit only wraps the prior schema. Page text should stay the same. sentry-docs must deploy before public API pages use the new pin. develop-docs also ships this SHA because it shares src/. The develop-docs site does not render those API pages.

Risk

A failed schema fetch can omit API pages from the static build. Readers then see not-found pages on former API URLs. A slug change in the schema can also create those not-found pages. A broken API page can throw client errors on API URLs.

Intended effect

This pin does not add a new API page. Confirm that generated API pages still load. Absent looks like API page loads falling toward zero while all page loads stay near 16994 per 24h.

Signal Baseline Window Rule Source
docs.page.load with page_type:api and environment:production 784 loads. 4.6% of 16994 all page loads 2026-10-20T17:16Z to 2026-10-21T17:16Z Hold in the 671-784 daily band. Absent: fall toward 0 while all page loads hold Sentry org sentry, project docs. Query page_type:api environment:production. Field sum(value, docs.page.load, counter, none)
docs.page.load with page_type:api and environment:production 4695 loads. About 671 per day 2026-10-14T17:16Z to 2026-10-21T17:16Z 671 per day is the low end of the hold band Same query over 7d

Regression watch

A bad pin can hide old API slugs or crash API pages. Watch not-found pages and client errors on the API path.

Signal Baseline Window Rule Source
docs.page.not_found with requested_path:api* and environment:production 13 counts. 1.7% of 784 API page loads 2026-10-20T17:16Z to 2026-10-21T17:16Z Hold in the 1.2-1.7% band of API page loads. Detected: rise above that band Sentry org sentry, project docs. Query environment:production requested_path:api*. Field sum(value, docs.page.not_found, counter, none)
docs.page.not_found with requested_path:api* and environment:production 56 counts. 1.2% of 4695 API page loads 2026-10-14T17:16Z to 2026-10-21T17:16Z 1.2% is the low end of the not-found rate band Same query over 7d
Error events with http.url:*/api/* and environment:production 15 errors. 1.9% of 784 API page loads 2026-10-20T17:16Z to 2026-10-21T17:16Z Hold this 24h share. Detected: the share rises while API page loads hold Sentry org sentry, project docs. Query environment:production http.url:*/api/* on errors. Field count()

If the not-found rate rises, inspect requested_path for dropped API category slugs.

Not observable

The served OpenAPI text is not in telemetry. Pageload traces for /api/ URLs did not return a usable baseline. The 7d API error count timed out. The prior-day 24h API load slice was not isolated from the 7d total.

This branch was successfully deployed

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