Skip to content

Bump API schema to 33b92f28 - #20220

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

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

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API 404s, client errors on those pages, and API page latency. An issue escalates when 404s rise or API page loads fall.

Services: sentry-docs.

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

Plan

What changed

API reference pages now build from OpenAPI schema commit 33b92f28. The OpenAPI JSON blob equals the previous pin. sentry-docs must deploy before this pin is live. develop-docs also builds this src file. It does not generate OpenAPI API pages. Catalog id sentry-docs matches the Vercel production project and the docs.sentry.io site. Runtime telemetry uses Sentry project docs, which is not a catalog id.

Risk

A bad static generation can drop API routes. Those URLs then return 404. A broken ApiPage render shows client errors on API reference pages. Reach is every reader of product API reference pages. The JSON blob did not change, so a content mismatch is unlikely. The remaining risk is a failed rebuild of those pages.

Intended effect

This pin adds no new API page and no new metric. Git blob 958bea77 is the same at both SHAs. After deploy, API page loads should hold. Absent looks like page_type=api loads falling toward zero while other page types still load.

Signal Baseline Window Rule Source
docs.page.load with page_type=api 836 in 24h. 4749 in 7d, about 680 per day. Friday 24h sits above the 7d daily mean. 2026-10-22T22:18Z to 2026-10-23T22:18Z and 2026-10-16T22:18Z to 2026-10-23T22:18Z Hold the 24h sum in 500-1000. Absent if it falls below 500 while other page types still load. Sentry org sentry, project docs. Query page_type:api environment:production. Field sum(value, docs.page.load, counter, none).

Regression watch

A dropped API route shows as a 404. A broken API page shows as a client error. Watch both, plus latency on the same path. Split loads by api_category because events and projects carry most OpenAPI traffic.

Signal Baseline Window Rule Source
docs.page.not_found on requested_path api* 11 in 24h, 1.3% of 836 API loads. 77 in 7d, 1.6% of 4749 API loads. Top paths: api/events 4, api/projects 3, api/alerts 2. 2026-10-22T22:18Z to 2026-10-23T22:18Z and 2026-10-16T22:18Z to 2026-10-23T22:18Z Hold the 404 share in 1.3-1.6% of API page loads. Detected if the 24h share rises above 3% or the 24h count rises above 25. Sentry org sentry, project docs. Query environment:production requested_path:api*. Field sum(value, docs.page.not_found, counter, none). Pair with docs.page.load page_type=api.
Client errors on /api/ URLs 10 errors in 24h on 817 pageload and navigation spans. Rate 1.2%. Top titles: TypeError reading U9 4, Event promise rejection 2, Algolia fetch fail 2. Algolia fetch fails are existing noise. 2026-10-22T22:18Z to 2026-10-23T22:18Z Hold the error rate near 1.2% of API navigations. Detected if 24h errors rise above 25 or the rate rises above 3%. Sentry org sentry, project docs. Errors query environment:production (http.url:*/api/* OR transaction:*/api/*). Volume query span.op:[pageload,navigation] environment:production url.full:*docs.sentry.io/api*.
p95 pageload and navigation on /api/ 7379 ms in 24h. 6253 ms in 7d. Count 817 in 24h and 4170 in 7d. Traces sample at 30%. 2026-10-22T22:18Z to 2026-10-23T22:18Z and 2026-10-16T22:18Z to 2026-10-23T22:18Z Hold p95 in 6.3-7.4 s. Detected if p95 rises above 10 s. Sentry org sentry, project docs. Query span.op:[pageload,navigation] environment:production url.full:*docs.sentry.io/api*. Fields count(), p95(span.duration).
docs.page.load page_type=api by api_category Last 24h: events 144, projects 70, releases 54. Null api_category 346 is MDX API guide pages, not OpenAPI pages. 2026-10-22T22:18Z to 2026-10-23T22:18Z Hold events and projects in 70-150% of those counts. Detected if either falls below half while total API loads hold. Sentry org sentry, project docs. Query page_type:api environment:production grouped by api_category.

Not observable

The running build does not emit the OpenAPI SHA, so the executor cannot see the pin in telemetry. A 48h page-load timeseries timed out. The prior-day 24h sum is therefore unknown. The 7d API error query used a different url filter than the 24h query, so that 7d error count is not a baseline. No synthetic check reads API page body text. MDX file-not-found logs were 0 in 24h and are not on this OpenAPI path.

This branch was successfully deployed

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