Skip to content

Bump API schema to 7c51e556 - #20048

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

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

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 10:51pm UTC
sentry-docs Ready Ready Preview Oct 16, 2026 10:51pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit c440878 into master Oct 16, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-7c51e556 branch October 16, 2026 22:46
@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 change pins a new API schema revision at build time. API reference pages should keep loading. Signals are API page loads, API 404s, and client errors on API URLs. An issue escalates when API page loads drop or API 404s rise.

Services: sentry-docs.

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

Plan

What changed

Public API reference pages now build from schema revision 7c51e556. That schema commit did not change the OpenAPI document. Category and endpoint pages under /api/ should keep serving the same content. sentry-docs must deploy before this is live. The Vercel project sentry-docs is the ship that generates these pages. develop-docs shares this repository. That build does not fetch this schema and does not render these pages.

Risk

A missing or invalid schema can omit API pages from the static build. Readers then get 404s on former endpoint URLs. Bad endpoint data can crash an API page at request time. Other docs sections do not read this schema at request time.

Intended effect

This pin does not add a new page or counter. The schema commit did not change openapi-derefed.json. Confirm that API pages still load after deploy. absent looks like API page loads falling toward zero while other page types still load.

Signal Baseline Window Rule Source
API page loads (docs.page.load, page_type:api) 0.50-0.64 TPM. Last 24h was 742 loads. Prior 24h was 924 loads. 2026-10-14T22:47:13Z to 2026-10-16T22:47:13Z Hold in this band. The OpenAPI document did not change, so volume should not shift. absent if the rate falls toward 0 while other page_type values hold. Sentry org sentry, project docs. Metric docs.page.load. Query page_type:api environment:production. Aggregate sum(value).

Regression watch

A bad schema shows up as missing API URLs or crashes on those pages. Existing 404s already concentrate on api/alerts. Treat a jump in new requested_path values as worse than a small rise on api/alerts.

Signal Baseline Window Rule Source
API 404 share (docs.page.not_found, requested_path:api*) 0.4-1.2% of API page loads. Last 24h was 9 404s over 742 loads. Prior 24h was 4 404s over 924 loads. Last 24h paths were api/alerts 6, api/projects 1, api/discover 1, api/guides 1. 2026-10-14T22:47:13Z to 2026-10-16T22:47:13Z Hold at or below the top of this band. detected if the share rises above 1.2% or many new API paths 404. Sentry org sentry, project docs. Metric docs.page.not_found. Query environment:production requested_path:api*. Pair with docs.page.load page_type:api.
Client errors on API URLs 0.22-0.40% of API page loads. Last 24h was 3 errors over 742 loads. Prior 24h was 2 errors over 924 loads. Last 24h titles were Kapa and Algolia fetch failures. 2026-10-14T22:47:13Z to 2026-10-16T22:47:13Z Hold in this band. detected if the rate rises above 0.40% or new titles from API page render appear. Sentry org sentry, project docs. Errors query environment:production http.url:*/api/*.

If API 404s rise, inspect requested_path for dropped endpoint slugs. If new error titles appear, inspect the catch-all route /:path*? that serves these pages.

Not observable

Pageload latency on API URLs is not available from a clean query. transaction:/api/* returned zero spans. Next.js names this catch-all /:path*?. A follow-up pageload query on docs.sentry.io/api/ timed out. The pinned schema SHA is a build-time fetch. Production does not emit that SHA as a runtime tag. Endpoint prose content has no fingerprint metric.

This branch was successfully deployed

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