Skip to content

Bump API schema to 96ef41e3 - #20267

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 4362416 into master Oct 27, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-96ef41e3 branch October 27, 2026 17:50
@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 change rebuilds API reference pages from a new schema pin that matches the prior schema file. The plan checks API page loads, API 404s, and client errors on those pages. An issue escalates when API page loads drop or API 404s rise.

Monitoring in production

Services: sentry-docs.

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

Plan

What changed

Requests to /api/ category and endpoint pages now render from OpenAPI schema pin 96ef41e3. The schema JSON at this pin matches pin 5bd01cda. The change is live after sentry-docs deploys. develop-docs shares this module but does not fetch or render OpenAPI pages.

Risk

The user docs build fetches this schema while it generates every page path. A missing or invalid schema file fails that production build. A schema that parses but drops endpoints returns 404s for old API URLs. A schema that changes slugs breaks inbound links to those pages. This pin does not change the schema JSON. Those content failures are unlikely for this deploy. Client failures on API pages would show as errors on the catch-all route.

Intended effect

This pin does not add a metric or a new route. The schema file is unchanged. Confirm the change by API page loads holding as a share of all page loads. absent looks like that share falling toward zero while other page types hold.

Signal Baseline Window Source Rule
API page-load share 3.9% (761 of 19306) in the latest 24h. 4.3% (5028 of 117020) over 7d. 2026-10-26T17:52Z to 2026-10-27T17:52Z and 2026-10-20T17:52Z to 2026-10-27T17:52Z Sentry metrics, org sentry, project docs. docs.page.load with environment:production, grouped by page_type. API row over all rows. Hold in 3.9-4.3%.
API page-load count 761 in the latest 24h. 1026 in the prior 24h. 718 per day over 7d. 2026-10-26T17:52Z to 2026-10-27T17:52Z, 2026-10-25T17:52Z to 2026-10-26T17:52Z, and 2026-10-20T17:52Z to 2026-10-27T17:52Z Sentry metrics, org sentry, project docs. docs.page.load with environment:production page_type:api. Use with the share. Daily volume is bursty. Do not treat a 761-1026 swing alone as proof.

Regression watch

This pin can drop API pages if the fetched schema is empty or renamed. It can also fail client render on those pages. Watch API 404s, client errors on API URLs, and platforms page loads as the sibling path.

Signal Baseline Window Source Rule
API 404 rate 1.7% (13 of 761) in the latest 24h. 0.4% (4 of 1026) in the prior 24h. 2026-10-26T17:52Z to 2026-10-27T17:52Z and 2026-10-25T17:52Z to 2026-10-26T17:52Z Sentry metrics, org sentry, project docs. docs.page.not_found with environment:production requested_path:api*, over docs.page.load with page_type:api. Hold in 0.4-1.7% of API page loads. Rise above the band.
Client errors on API URLs 3 events in 24h. 0.4% of 761 API page loads. 2026-10-26T17:52Z to 2026-10-27T17:52Z Sentry errors, org sentry, project docs. environment:production (http.url:*/api/* OR transaction:*/api/*). Hold in 0-0.4% of API page loads.
Platforms page-load share 55.1% (10640 of 19306) in the latest 24h. 57.3% (67085 of 117020) over 7d. 2026-10-26T17:52Z to 2026-10-27T17:52Z and 2026-10-20T17:52Z to 2026-10-27T17:52Z Sentry metrics, org sentry, project docs. docs.page.load with environment:production, page_type:platforms over all page_type rows. Hold in 55-57%. If this share holds while API page loads collapse, the failure is on the API path.

Site-wide pageload p95 was 10.9s in the latest 24h. API pageload and navigation p95 was 8.2s on 767 sampled spans. Latency is not a primary watch for this identical schema pin.

Not observable

Production telemetry does not report the live schema SHA. The plan cannot confirm the pin itself. API endpoint copy is not in metrics. Client errors on API URLs were not measured for the prior 24h window with the same query.

This branch was successfully deployed

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