Skip to content

Bump API schema to 323c73b4 - #20025

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 16, 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 16, 2026 8:16am UTC
sentry-docs Ready Ready Preview Oct 16, 2026 8:16am UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit e10066a into master Oct 16, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-323c73b4 branch October 16, 2026 08:11
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 16, 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 16, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API 404s, and client errors on API reference pages. An issue escalates when API page loads fall toward zero. An issue also escalates when those 404s or client errors rise.

Services: sentry-docs.

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

Plan

What changed

Requests to API reference pages now render from OpenAPI schema 323c73b4. The dereferenced schema file did not change from c1046d1c. sentry-docs must deploy before this pin is live. develop-docs shares src but does not call the OpenAPI resolver, so this pin is not reachable there.

Risk

A missing or invalid schema file fails the production build and blocks the site. A dropped or renamed endpoint returns 404 on its old URL. A schema the page renderer cannot read throws client errors on API pages.

Intended effect

API reference pages must keep recording docs.page.load with page_type api. The schema JSON is unchanged, so volume should hold. absent looks like that counter near zero while other page_type values still load.

Signal Baseline Window Rule Source
docs.page.load page_type:api 29-46 loads per hour (703 then 1105 per 24h) 2026-10-14T08:12:28Z to 2026-10-15T08:12:28Z and 2026-10-15T08:12:28Z to 2026-10-16T08:12:28Z Hold in this band. Do not expect a rise. Sentry metrics sentry/docs production. Query page_type:api. Sum docs.page.load.

Regression watch

This pin can drop or rename API URLs. It can also throw while those pages render. Watch 404s and client errors on the /api path. Put each risk on those checks. A build fetch failure never reaches runtime. That gap is below.

Signal Baseline Window Rule Source
docs.page.not_found requested_path:api* 13 events in 48h. 0.7% of 1808 API page loads 2026-10-14T08:12:28Z to 2026-10-16T08:12:28Z Hold this share. detected if the share rises while API page loads hold. Sentry metrics sentry/docs production. Query requested_path:api*. Sum docs.page.not_found.
Client errors on /api URLs 3-4 events per 24h. 0.36-0.43% of API page loads (TypeError) 2026-10-14T08:12:28Z to 2026-10-15T08:12:28Z and 2026-10-15T08:12:28Z to 2026-10-16T08:12:28Z Hold this rate. detected if the rate rises above the band. Sentry errors sentry/docs production. Query http.url:*/api/* or transaction:*/api/*.

If 404s rise, inspect requested_path values under api. If errors rise, inspect TypeError events on those URLs.

Not observable

Whether served HTML matches schema 323c73b4. No content hash exists in telemetry. Pageload p95 on API URLs. A transaction:/api* pageload query returned zero. The production build fetch of openapi-derefed.json. That failure blocks deploy and never appears at runtime.

This branch was successfully deployed

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