Skip to content

Bump API schema to c775f862 - #20182

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 19ca335 into master Oct 22, 2026
7 of 9 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-c775f862 branch October 22, 2026 17:10
@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 not-found counts, and client errors on those pages. An issue escalates when API page loads fall or those not-found counts and errors rise.

Services: sentry-docs.

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

Plan

What changed

The build now fetches the OpenAPI document at schema SHA c775f862.
API reference pages under /api/{category}/ and /api/{category}/{endpoint}/ rebuild from that document.
The OpenAPI JSON at c775f862 matches the JSON at 969e159e.
Visible page content should stay the same.
sentry-docs must deploy before this change is live.
develop-docs also builds this source file.
That site does not generate API reference pages, so it is not in this watch.

Risk

A bad schema can fail the production build and block the site update.
A bad schema shape can make API reference pages 404 or throw in the page renderer.
The blast radius is every generated API category and endpoint page.
Other docs pages do not read this schema at request time.

Intended effect

The schema document did not change, so the intended shift is none.
Pages with an api_category attribute must keep loading after the new release.
Absent looks like other page types loading on that release while api_category loads stay at 0.

Signal Baseline Rule Source
docs.page.load share with page_type api and api_category set 2.5% of all page loads. 464 of 18906 loads in 2026-10-21T17:11Z to 2026-10-22T17:11Z. Hourly page_type api counts were 8-68 in complete hours and may be seasonal. Hold near 2.5%. Confirmed when the new release records api_category loads above 0. Absent when other page types load on that release and api_category loads stay at 0. Sentry org sentry project docs. Counter docs.page.load. Query: metric.name:docs.page.load AND metric.type:counter AND sentry.environment:production AND page_type:api. Group by api_category. Ignore the null api_category bucket.

Regression watch

A dropped or renamed endpoint 404s for readers who follow old API URLs.
A renderer throw shows as a client error on those pages.
Pageload failures on /api/ paths are the availability symptom.
If one api_category drops to 0 while others hold, treat that as a regression.
Traffic may be seasonal. Night hours are quieter than business hours.

Signal Baseline Rule Source
API not-found rate 2.3% of API attempts. 20 not-found and 868 page_type api loads in 2026-10-21T17:11Z to 2026-10-22T17:11Z. Top paths were api/alerts at 9, api/events at 4, api/organizations at 3. Hold near 2.3%. Detect a clear rise above this 24h rate, or a new api_category path that was not in this window. Sentry org sentry project docs. Counter docs.page.not_found. Query: requested_path:api* environment:production. Pair with docs.page.load page_type:api.
Client errors on /api/ pages 5 events in 2026-10-21T17:11Z to 2026-10-22T17:11Z. 1.1% of 464 api_category loads. Site-wide errors were 218. Title was Event captured as promise rejection. Hold near 1.1% of api_category loads. Detect a rise toward a larger share of the 218 site-wide errors. Sentry org sentry project docs. Errors. Query: environment:production AND (transaction:"/api/" OR url:"/api/").
/api/ pageload and navigation failure rate 1.4% of 713 sampled spans in 2026-10-21T17:11Z to 2026-10-22T17:11Z. p95 duration was 7.0s. User traces sample at 30%. AI agent traces sample at 100%. Hold near 1.4%. Detect a clear rise above this 24h failure rate. Do not treat raw span count as volume. Sentry org sentry project docs. Spans. Query: span.op:[pageload,navigation] environment:production url.path:/api/*. Fields: failure_rate(), count(), p95(span.duration).

Not observable

No runtime signal records the schema SHA on a rendered page.
Build-time fetch or parse failures never reach production.
develop-docs has no API reference page signal for this change.

This branch was successfully deployed

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