Skip to content

Bump API schema to be372128 - #19887

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 9, 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 9, 2026 11:15pm UTC
sentry-docs Ready Ready Preview Oct 9, 2026 11:15pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 4307693 into master Oct 9, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-be372128 branch October 9, 2026 23:06
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 9, 2026
@github-actions

github-actions Bot commented Oct 9, 2026

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 9, 2026 •

Copy link
Copy Markdown
Contributor
  • The change pins a new OpenAPI schema revision.
  • Generated API pages should keep the same paths.
  • The plan checks API page loads and API 404s. An issue escalates when 404s rise or page loads fall.

Services: sentry-docs, develop-docs.

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

Plan

What changed

Build-time fetch of the OpenAPI document now uses SHA be372128. The consumed openapi-derefed.json file did not change in that schema commit. Public API category and endpoint pages keep the same generated paths after deploy.

sentry-docs must deploy before this pin is live. develop-docs also ships the shared src/ file. develop-docs does not render these OpenAPI pages.

Risk

A bad schema parse can drop generated API routes. Users then get 404s on /api/ category and endpoint pages. A render break on those pages can throw client errors. develop-docs has no user-facing API-page blast radius from this pin.

Intended effect

This change has no queryable new page. The consumed OpenAPI document did not change. Do not treat a steady 404 count as proof that the pin did new work.

absent looks like a later window that still cannot show a new API path or a new page-load attribute from this SHA. There is no new counter to rise from zero.

Regression watch

A dropped or broken schema build would 404 former /api/ paths or cut API page loads. Watch those two signals. Also watch client errors whose URL contains /api/.

Signal Band Window Source Rule
docs.page.load with page_type:api and environment:production 29-32 loads per hour 2026-10-08T23:07:00Z to 2026-10-09T23:07:00Z (692 events) and 2026-10-02T23:07:00Z to 2026-10-09T23:07:00Z (5359 events) Sentry metrics, project docs, query metric.name:docs.page.load AND metric.type:counter AND page_type:api AND environment:production Hold this band. A fall below the band means generated API pages may be missing.
docs.page.not_found with requested_path:api* and environment:production 0.9-1.8% of API loads plus 404s (6 events in 24h, 97 events in 7d) 2026-10-08T23:07:00Z to 2026-10-09T23:07:00Z and 2026-10-02T23:07:00Z to 2026-10-09T23:07:00Z Sentry metrics, project docs, query metric.name:docs.page.not_found AND metric.type:counter AND requested_path:api* AND environment:production Hold this band. A rise above the band means API routes are missing.
Error events with environment:production and url:*/api/* 0-15 events per 24h 2026-10-08T23:07:00Z to 2026-10-09T23:07:00Z Sentry errors, project docs, query environment:production AND url:*/api/* Hold this band. A rise above 15 per 24h, or a new exception type, is a regression. The 24h sample was 13 promise rejections and 2 Algolia fetch failures.

If 404s rise, check which requested_path values appear. A new api/<category> path that used to load is the first place to look.

Not observable

Isolated pageload latency for documentation /api/ URLs. Transaction names use the catch-all route, so URL filters also matched unrelated spans.

The schema body text on each API page. No telemetry shows that text.

This branch was successfully deployed

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