Skip to content

Bump API schema to c4a364de - #20167

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

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

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 8:32am UTC
sentry-docs Ready Ready Preview Oct 22, 2026 8:32am UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit cf9a67c 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-c4a364de branch October 22, 2026 08:26
@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 change rebuilds API pages from a new schema pin. The schema document itself did not change.
  • The plan checks API page loads, the API not-found rate, and client errors on those pages.
  • An issue escalates when API page loads fall relative to site loads. It also escalates when not-found events or client errors on those pages rise.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

Build-time fetch of the OpenAPI schema now uses commit c4a364de.
That commit only cuts package version 0.380.0.
The OpenAPI document matches 8f61c4a4.
After deploy, API pages under /api/ still render from the same schema.
sentry-docs must deploy before those pages rebuild.
develop-docs also deploys this shared src/ file.
It does not fetch the schema or render API pages.

Risk

If the schema fetch fails, the sentry-docs production build fails.
The new pin then does not go live.
If page generation drops endpoints, existing API page URLs return not-found.
If the shared app module fails to compile, both site deploys can fail.
Runtime blast radius is API pages.
Other pages should not change.

Intended effect

The schema JSON did not change, so no new endpoint text appears.
Success is that API pages still load after the rebuild.
Use the share of site page loads as the proxy.
Absent looks like this: the API page load share falls below 2% while site page loads hold.
That pattern means the rebuild omitted API pages.

Signal Baseline Rule Source
API page load share. docs.page.load with page_type:api divided by all docs.page.load. Production. 4.2% in 2026-10-21T08:27:31Z to 2026-10-22T08:27:31Z. 781 API page loads over 18490 site page loads. 4.7% in the prior 24h from complete hourly buckets 2026-10-20T09:00Z to 2026-10-21T08:00Z. 815 over 17384. The 2026-10-20T08:00Z hour is missing from the timeseries. Hold in 4.2-4.7%. The expected shift is none. Sentry org sentry project docs. Query metric.name:docs.page.load AND page_type:api AND sentry.environment:production and metric.name:docs.page.load environment:production.

Regression watch

This rebuild could omit API pages or crash their client render.
A failed or partial deploy could also drop site page loads.

Signal Baseline Rule Source
API not-found rate. docs.page.not_found with requested_path:api* divided by API page loads. Production. 2.2% in 2026-10-21T08:27:31Z to 2026-10-22T08:27:31Z. 17 not-found over 781 API page loads. 1.7% in the prior 24h. 14 over 815. Hold in 1.7-2.2%. Escalate if the rate rises above the band. Sentry org sentry project docs. Query metric.name:docs.page.not_found AND requested_path:api* AND sentry.environment:production.
Client errors on API pages. Error events with URL or transaction matching */api/*, divided by API page loads. Production. Symptom-class. 1.5% in 2026-10-21T08:27:31Z to 2026-10-22T08:27:31Z. 12 errors over 781 API page loads. 0.5% in the prior 24h. 4 over 815. Last 24h types were Event 5, TypeError 4, UnhandledRejection 2, NotSupportedError 1. Hold in 0.5-1.5%. Escalate if the rate rises above the band. If it rises, inspect TypeError events on API pages. Sentry org sentry project docs. Query environment:production AND (url:"*/api/*" OR transaction:"*/api/*").
Site page loads. All docs.page.load in production. Sibling path on the same app. 18490 in 2026-10-21T08:27:31Z to 2026-10-22T08:27:31Z. 17384 in the prior 24h from complete hourly buckets 2026-10-20T09:00Z to 2026-10-21T08:00Z. Hold in 17384-18490 per 24h. Escalate if 24h volume falls below the band while API not-found or API errors rise. Sentry org sentry project docs. Query metric.name:docs.page.load environment:production.

Not observable

Which schema SHA the live build pinned. The two SHAs serve the same JSON.
Pageload span latency for /api/ URLs. Queries on url.full:*/api/* and sentry.segment.name:/api/* both returned zero rows in 2026-10-21T08:27:31Z to 2026-10-22T08:27:31Z.
Pre-ship 48h error rate for develop-docs. That site does not render API pages. A 24h count exists. 35 production errors in 2026-10-21T08:27:31Z to 2026-10-22T08:27:31Z. The prior 24h was not measured.

@cursor

cursor Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages still load after the schema pin, and API errors stayed in the old band.

This branch had an error being deployed

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