Skip to content

Bump API schema to c2a832ce - #20191

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

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

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 Error Error Oct 22, 2026 7:32pm UTC
sentry-docs Error Error Oct 22, 2026 7:32pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 7471f43 into master Oct 22, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-c2a832ce branch October 22, 2026 19:29
@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, missing-page counts on that path, pageload failures, and client errors. An issue escalates when missing-page counts rise or pageload failures rise.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

The docs build now pins OpenAPI schema SHA c2a832ce. Generated API reference pages still render from that pin. The pin commit did not change the dereferenced OpenAPI document. Page copy should match the prior pin. sentry-docs must deploy before those pages are live. develop-docs also ships the shared source. It does not render OpenAPI pages.

Risk

A bad schema can drop endpoint pages or fail the static build. Readers then see missing API reference pages. Static API guide pages share the same catch-all route. A render fault can also throw client errors on those pages.

Intended effect

The change worked if generated API reference pages keep loading. This pin adds no new counter. The OpenAPI document did not change, so load volume should hold. Absent looks like loads with api_category set fall toward zero while other docs loads hold. Of 871 API page loads in the last 24h, 469 had api_category set. Those are the schema-built pages.

Signal Baseline Rule Source
docs.page.load with page_type:api 771-871 per 24h. Last 24h 871. Prior 24h 771. Hold in band. Absent if volume falls far below 771 while other docs loads hold. Sentry project docs, environment production. Query page_type:api. Last window 2026-10-21T19:31:08Z to 2026-10-22T19:31:08Z. Prior window 2026-10-20T19:31:08Z to 2026-10-21T19:31:08Z.

Regression watch

Missing pages are the first user symptom if the schema omits an endpoint. Watch 404s by requested_path so one category cannot hide in the total. Pageload failures and client errors cover a broken render on the same path. Traces sample at 30 percent. Use rates, not raw pageload counts.

Signal Baseline Rule Source
docs.page.not_found share on requested_path:api* versus docs.page.load page_type:api 1.4-1.6%. Last 24h 14 of 871. Prior 24h 11 of 771. Last 24h path split: api/alerts 9, api/projects 2, api/events 2, api/discover 1. Hold in band. Detected if the share rises above 1.6% or one path jumps while total loads hold. Sentry project docs, environment production. Last window 2026-10-21T19:31:08Z to 2026-10-22T19:31:08Z. Prior window 2026-10-20T19:31:08Z to 2026-10-21T19:31:08Z. 48h not_found total 25.
pageload failure_rate for url:docs.sentry.io/api/ 1.6-5.6%. Last 24h 1.63% of 430 pageloads. Prior 24h about 5.6% of 413 pageloads. 48h pooled 3.56% of 843. Hold in band. Detected if the rate rises above 5.6%. The rate varied widely across these two days. Sentry project docs, environment production, span.op:pageload. Last window 2026-10-21T19:31:08Z to 2026-10-22T19:31:08Z. 48h window 2026-10-20T19:31:08Z to 2026-10-22T19:31:08Z.
pageload p95 duration for url:docs.sentry.io/api/ 7.8-8.0s. Last 24h 8045ms. 48h pooled 7777ms. Hold in band. Detected if p95 rises above 8.0s. Sentry project docs, environment production, span.op:pageload. Same windows as failure_rate.
error share on url:docs.sentry.io/api/ versus docs.page.load page_type:api 0.7-1.8%. Last 24h 6 of 871. Prior 24h 14 of 771. All 6 last-24h events were promise-rejection Event titles. Hold in band. Detected if the share rises above 1.8% or a new error title appears. Sentry project docs, environment production. Exclude ip-ranges and source-map URLs. Last window 2026-10-21T19:31:08Z to 2026-10-22T19:31:08Z. Prior window 2026-10-20T19:31:08Z to 2026-10-21T19:31:08Z.

Do not use transaction:/api/ for this watch. That filter matches the ip-ranges and source-map routes, not the schema pages.

Not observable

The prior 24h count of docs.page.load with api_category set did not return. The 48h query timed out. The executor cannot compare schema-built loads to the same hours a day earlier. Per-category load counts also lack a prior-day band. develop-docs has no API reference page signal for this pin.

@cursor

cursor Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • Generated API reference pages kept loading after the ship, and failure signals stayed in band.

This branch had an error being deployed

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