Skip to content

Bump API schema to ae87efef - #20186

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

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

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API 404s, and API page latency. An issue escalates when API pages stop loading or API 404s rise.

Services: sentry-docs.

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

Plan

What changed

API reference pages now build from OpenAPI schema SHA ae87efef. The schema JSON matches the previous pin. Page text should stay the same. sentry-docs must deploy before this is live. develop-docs shares this source but does not emit /api/ pages, so it is omitted.

Risk

A bad schema can omit /api/ routes at build time. Users then see 404 pages for API docs. A schema that parses but has odd fields can break API page render. The blast radius is every /api/ docs page. Other docs paths do not read this SHA.

Intended effect

API pages must keep loading after deploy. The schema JSON did not change, so there is no new page text to detect. Absent: API page loads fall toward zero while other docs pages still load.

Last 24h API page loads were 865. The 48h total was 1650, so the prior 24h was about 785. Last 24h all page loads were 18629. API loads were 4.6% of that population.

Signal Baseline Window Rule Source
API page loads 785-865 loads per 24h 2026-10-20T17:30:07Z to 2026-10-22T17:30:07Z Hold in this band Sentry sentry/docs docs.page.load with page_type:api environment:production

Regression watch

This change can drop API routes or break API page render. Watch 404s first. Watch API pageload latency on the same path.

Last 24h had 20 API 404s and 865 API page loads. That share is 2.3%. Prior 24h had 7 API 404s and about 785 loads. That share is 0.9%. Current 404s already include api/alerts, api/events, and api/organizations.

Last 24h API pageload p95 was 8782ms on 403 sampled spans. Last 48h p95 was 7995ms on 827 spans. This p95 may include slow agent traffic. User traces sample at 30%. Agent traces sample at 100%.

Signal Baseline Window Rule Source
API 404 share 0.9-2.3% of API page loads 2026-10-20T17:30:07Z to 2026-10-22T17:30:07Z Hold in this band. Escalate if the share rises above 2.3% while API loads fall Sentry sentry/docs docs.page.not_found with environment:production requested_path:api* over docs.page.load with page_type:api
API pageload p95 8.0-8.8s 2026-10-20T17:30:07Z to 2026-10-22T17:30:07Z Hold in this band Sentry sentry/docs spans span.op:pageload url.full:*docs.sentry.io/api* environment:production

If API 404s rise, inspect which requested_path grew. Then compare it to the live /api/ sidebar.

Not observable

The schema SHA is not a runtime metric. The 48h API error query timed out, so there is no prior-day error band. Last 24h had 5 production errors on /api/ URLs. All five used the title Event captured as promise rejection. Field-level copy on each API page is not in telemetry.

This branch was successfully deployed

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