Skip to content

Bump API schema to 12440699 - #20271

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit e3348d3 into master Oct 27, 2026
12 of 14 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-12440699 branch October 27, 2026 18:37
@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. The plan checks API page loads, API 404s, and failed API page requests. An issue escalates when API page loads drop or API 404s rise.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

API reference pages now fetch schema 12440699 at build time and at request time.
The schema document matches the prior pin. Endpoint URLs should stay the same.
sentry-docs must deploy before the pin is live on API pages.
develop-docs also ships this shared source file. It does not generate those API pages.
Both Vercel projects build this repository. Catalog files say shared src ships to both.

Risk

A failed schema fetch or JSON parse throws while API pages render.
Those requests then return 500 instead of the reference page.
A slug change would 404 old endpoint URLs. This pin does not change slugs.
Other docs pages do not call this resolver at request time.

Intended effect

The pin worked when API pages keep loading at the pre-ship rate.
Absent looks like API page loads falling toward zero while other page types hold.
Hold daily API loads in the band. Hold the share of all page loads near 4.0%.

Signal Baseline Rule Source
docs.page.load with page_type api 777 counts in 2026-10-26T18:38:46Z to 2026-10-27T18:38:46Z. 5687 counts in 2026-10-20T18:38:46Z to 2026-10-27T18:38:46Z. That is 813 per day. Share was 777 of 19446 page loads, 4.0%. Hold daily count in 777-813. Hold share in 3.9-4.2%. Absent if API loads fall toward zero while other page types hold. Sentry org sentry, project docs. Metric docs.page.load. Filter page_type:api.

Regression watch

A bad pin can 404 or 500 API pages, or slow those pageloads.
Watch the 404 rate on api paths, 5xx on those URLs, and pageload p95.
Traces for this site are sampled at 30%.

Signal Baseline Rule Source
docs.page.not_found with requested_path api* 13 counts in 2026-10-26T18:38:46Z to 2026-10-27T18:38:46Z, 1.7% of API page loads. 69 counts in 2026-10-20T18:38:46Z to 2026-10-27T18:38:46Z, 1.2% of API page loads. Hold the rate in 1.2-1.7% of API page loads. A rise above the band is a regression. Sentry org sentry, project docs. Metric docs.page.not_found. Filter requested_path:api*.
5xx spans on url.path /api/ 0 counts in 2026-10-26T18:38:46Z to 2026-10-27T18:38:46Z. 0 counts in 2026-10-20T18:38:46Z to 2026-10-27T18:38:46Z. Hold at 0. Any 5xx on these URLs is a regression. Sentry org sentry, project docs. Spans with url.path:/api/ and span.status_code:5*. Environment production.
p95 pageload and navigation on url.path /api/ 7924ms and 647 spans in 2026-10-26T18:38:46Z to 2026-10-27T18:38:46Z. 7072ms and 5053 spans in 2026-10-20T18:38:46Z to 2026-10-27T18:38:46Z. Hold p95 in 7.1-7.9s. A rise above the band is a regression. The p95 may vary with client mix. Sentry org sentry, project docs. Spans span.op:[pageload,navigation] url.path:/api/ environment:production.

Not observable

The live pages do not expose the schema SHA, so the pin string itself is not measurable.
develop-docs has no generated API reference volume for this pin.
Error events may use the catch-all route name rather than /api/. Use the 5xx span check instead.

@cursor

cursor Bot commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages kept loading on the new release, and API 404s and 5xx stayed at zero.

This branch was successfully deployed

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