Skip to content

Bump API schema to 5c02c32a - #20260

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 13590b6 into master Oct 27, 2026
15 of 17 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-5c02c32a branch October 27, 2026 15:57
@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 plan checks generated API page loads, API 404s, and client errors on those pages. An issue escalates when API 404s rise or generated API pages stop loading.

Monitoring in production

Services: sentry-docs.

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

Plan

What changed

The docs build now fetches OpenAPI from schema commit 5c02c32a. That commit did not change openapi-derefed.json. Requests to generated API category and endpoint pages should render the same content. sentry-docs must deploy before this change is live. develop-docs shares this source tree but does not generate those pages.

Risk

A dropped or renamed endpoint makes former API URLs return 404. A render failure in the API page component shows client errors on those pages. After a successful deploy, this schema does not affect other docs sections.

Intended effect

Generated API pages still load after the rebuild. The schema commit added no new endpoints, so volume should hold. Absent looks like generated API page loads falling far below the band while other docs pages still load. The prior day had a higher generated-page share. That share may vary by weekday.

Signal Baseline Window Rule Source
Generated API page-load share 2.2-3.6% of all docs.page.load (426 of 19380, then 599 of 16847) 2026-10-26T15:57:00Z to 2026-10-27T15:57:00Z and prior 24h from 2026-10-25T15:57:00Z Hold in band. No rise is expected. Sentry org sentry, project docs, metric docs.page.load, query has:api_category over all docs.page.load

Regression watch

This diff could 404 former API URLs or throw on API page render. Watch 404s, client errors, and load time on /api/ pages. The prior day had fewer API 404s than the last 24h. That 404 rate may vary.

Signal Baseline Window Rule Source
API 404 share 0.5-1.5% of API attempts (5 of 975, then 12 of 806) 2026-10-25T15:57:00Z to 2026-10-26T15:57:00Z and 2026-10-26T15:57:00Z to 2026-10-27T15:57:00Z Do not rise above the band. Sentry org sentry, project docs, metric docs.page.not_found, query requested_path:api*, denominator docs.page.load page_type:api plus those 404s
API page client errors 0.21-0.25% of page_type:api loads (2 of 970, then 2 of 794) same 24h windows Hold near 2 errors per 24h. This count is small and may move without a real fault. Treat as detected if the 24h count exceeds 4. Sentry org sentry, project docs, errors environment:production http.url:*/api/*
/api/ pageload p95 7250-7690ms 2026-10-26T15:57:00Z to 2026-10-27T15:57:00Z is 7256ms. 48h through that end is 7689ms. Do not rise above the band. Traces are sampled at 30%. Sentry org sentry, project docs, spans span.op:[pageload,navigation] url.full:*/api/* environment:production

Not observable

No signal reports the live schema SHA or that rendered fields match this OpenAPI document. Page loads only show that generated pages exist. Static API guide pages under /api/ are not built from this schema. Server HTTP 4xx and 5xx spans for these pages were not present in project docs. 404s are recorded by the client docs.page.not_found metric instead.

This branch was successfully deployed

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