Skip to content

Bump API schema to 45d2f893 - #20223

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

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

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 11:11pm UTC
sentry-docs Ready Ready Preview Oct 23, 2026 11:11pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit d6e19be 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-45d2f893 branch October 23, 2026 23:05
@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

Generated API reference pages rebuild from a new schema. The plan checks those page loads, API-path 404s, and client errors on those pages. An issue escalates when 404s rise or those errors rise.

Services: sentry-docs.

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

Plan

What changed

Generated API reference pages now render from OpenAPI schema 45d2f893. The schema JSON changed three lines. sentry-docs must deploy before those pages are live. The same commit also deploys develop-docs. develop-docs does not generate API reference pages.

Risk

Old endpoint URLs return 404 if the schema renames or drops a slug. The API page component throws if the new schema shape does not match. A schema fetch failure fails the sentry-docs production build.

Intended effect

Generated API pages keep loading after deploy. That volume is a proxy. The new schema text is not queryable.

Absent looks like generated page loads falling below the band. Other docs pages would still load.

Generated page loads should hold in the 370-494 band per 24h. That band is the 7d daily mean through the last 24h.

Signal Baseline Rule Source
Generated API page loads. docs.page.load with page_type:api and api_category set 494 in 24h from 2026-10-22T23:06:10Z to 2026-10-23T23:06:10Z. 2590 in 7d from 2026-10-16T23:06:10Z to 2026-10-23T23:06:10Z, 370 per 24h. Band 370-494 per 24h Hold in the 370-494 band per 24h. Absent if the 24h value falls below 370 while all docs page loads hold near 16044 Sentry metrics, org sentry, project docs. Query environment:production page_type:api, group by api_category, drop the null group. 24h total docs.page.load was 16044

Regression watch

This change can 404 old API slugs. It can also throw in the API page component.

Watch API-path 404 rate. Watch client errors on API URLs. Watch p95 of API pageload and navigation. Watch static API page loads as a sibling slice.

If generated loads fall and static API loads hold, the schema is the likely cause. Last-24h client errors were browser noise. Titles were TypeError on U9, Algolia fetch failure, cdn.shopimgs.com fetch failure, and NS_ERROR_NOT_INITIALIZED. The 7d error rate is higher than the last 24h. Treat that rate as bursty.

Signal Baseline Rule Source
API-path 404 rate. docs.page.not_found with requested_path:api* over API page loads plus those 404s 15 404s and 837 API page loads in 24h from 2026-10-22T23:06:10Z to 2026-10-23T23:06:10Z, rate 1.76%. 81 404s and 4746 API page loads in 7d from 2026-10-16T23:06:10Z to 2026-10-23T23:06:10Z, rate 1.68%. Band 1.7-1.8% Hold in the 1.7-1.8% band Sentry metrics, org sentry, project docs. 404 query environment:production requested_path:api* on docs.page.not_found. Load query environment:production page_type:api on docs.page.load
Client error rate on API URLs over API page loads 10 errors and 837 API page loads in 24h from 2026-10-22T23:06:10Z to 2026-10-23T23:06:10Z, rate 1.2%. 322 errors and 4746 API page loads in 7d from 2026-10-16T23:06:10Z to 2026-10-23T23:06:10Z, rate 6.8%. Band 1.2-6.8% Do not rise above 6.8% on a 24h window. Also escalate on new error titles from the API page render Sentry errors, org sentry, project docs. Query environment:production http.url:*docs.sentry.io/api/*
p95 duration for pageload and navigation on /api/ URLs 7839ms from 827 spans in 24h from 2026-10-22T23:06:10Z to 2026-10-23T23:06:10Z. 6317ms from 4187 spans in 7d from 2026-10-16T23:06:10Z to 2026-10-23T23:06:10Z. Band 6.3-7.8s Do not rise above 7.8s Sentry traces, org sentry, project docs. Query span.op:[pageload,navigation] url.full:*/api/* environment:production
Static API page loads. docs.page.load with page_type:api and null api_category 343 in 24h from 2026-10-22T23:06:10Z to 2026-10-23T23:06:10Z. 2156 in 7d from 2026-10-16T23:06:10Z to 2026-10-23T23:06:10Z, 308 per 24h. Band 308-343 per 24h Hold in the 308-343 band per 24h Sentry metrics, org sentry, project docs. Query environment:production page_type:api, group by api_category, keep the null group

Not observable

The exact OpenAPI field that changed. GitHub omitted the patch for the large schema file. Whether rendered page text matches schema 45d2f893. A 404 rate for the unknown changed endpoint alone.

This branch was successfully deployed

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