Skip to content

Bump API schema to bd6c8410 - #20294

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Error Error Oct 28, 2026 6:00pm UTC
sentry-docs Ready Ready Preview Oct 28, 2026 6:00pm UTC

Request Review

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

Copy link
Copy Markdown
Contributor
  • The change pins a new OpenAPI schema at build. API reference pages then render from that pin.
  • The schema JSON did not change between the two pins. Page text should stay the same.
  • The plan checks API reference page loads, missing API pages, and client errors on those pages. An issue escalates when missing pages or client errors rise.

Rollout complete

Services: sentry-docs.

Plan

What changed

The build now fetches OpenAPI schema bd6c8410ffc459d136b6cfc0174aef2c47dac21b. After deploy, /api/ category and endpoint pages render from that pin.
The JSON at this pin matches the JSON at c97b5635f2ce85e04ad086ffe663aa11863413a8. The schema compare only changed changelog and package version. We do not expect new or removed endpoint pages.
sentry-docs must deploy before this change is live. develop-docs rebuilds from the same commit. That site does not call the resolver. It does not serve /api/ pages.

Risk

If slugs change, old /api/ URLs return a missing page. If the API page renderer throws, readers see a broken page. Those failures stay on the /api/ path. The JSON is unchanged, so those failures are unlikely. A bad fetch fails the build and the deploy does not start.

Intended effect

The pin is in use when API reference pages keep loading at the same share of all page loads. We do not expect a rise. The schema JSON did not change. Absent: that share falls below the band while total page loads hold. That means /api/ pages are missing.

Signal Baseline Rule Source
Share of docs.page.load with page_type:api in production 3.94-3.98% of all production docs.page.load Hold in that band Sentry org sentry project docs. Recent 24h 820 of 20582, 2026-10-27T17:54:16Z to 2026-10-28T17:54:16Z. Prior 24h 761 of 19338, 2026-10-26T17:54:16Z to 2026-10-27T17:54:16Z. Query docs.page.load with environment:production page_type:api. Divide by docs.page.load with environment:production.

Regression watch

A wrong pin can drop endpoint pages or break the API page renderer. Watch missing pages and client errors on that path.
api/prevent already accounts for 7 of 11 API missing pages in the recent 24h. Do not treat that path alone as new.

Signal Baseline Rule Source
docs.page.not_found with requested_path:api* as a share of API page loads 1.34-1.71% Hold in that band. A rise is a regression. Sentry org sentry project docs. Recent 24h 11 missing pages over 820 API page loads, 2026-10-27T17:54:16Z to 2026-10-28T17:54:16Z. Prior 24h 13 over 761, 2026-10-26T17:54:16Z to 2026-10-27T17:54:16Z. Query docs.page.not_found with requested_path:api* environment:production. Divide by docs.page.load with page_type:api environment:production.
Client errors on url:*/api/* as a share of API page loads 0.24-0.39% Hold in that band. A rise is a regression. Sentry org sentry project docs. Recent 24h 2 errors over 820 API page loads with url:*/api/*, 2026-10-27T17:54:16Z to 2026-10-28T17:54:16Z. Prior 24h about 3 over 761. The 48h count was 5 with http.url:*/api/*, 2026-10-26T17:54:16Z to 2026-10-28T17:54:16Z. The two filters are not identical.

Not observable

The text of each endpoint page is not scraped. Telemetry cannot confirm a field-level schema edit.
API missing pages were not split by category on the prior day. Only the recent 24h top path api/prevent is known.
Pageload duration on /api/ is not a usable band. The 24h p95 was 16.3s. The 48h pageload query timed out.

@cursor

cursor Bot commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API reference pages kept loading on this ship.

This branch had an error being deployed

1 failed and 1 active deployments
Preview – sentry-docs — 3f15b54b Deployed Oct 28, 2026 by vercel[bot]
Preview – develop-docs — 3f15b54b Deployed Oct 28, 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