Skip to content

Bump API schema to e9ca0c8b - #19748

Merged
sentry-api-schema-updater[bot] merged 1 commit into
masterfrom
bot/bump-api-schema-to-e9ca0c8b
Sep 30, 2026
Merged

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit ecc1a3a into master Sep 30, 2026
1 check was pending
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-e9ca0c8b branch September 30, 2026 19:26
@vercel

vercel Bot commented Sep 30, 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 Sep 30, 2026 7:37pm UTC
sentry-docs Ready Ready Preview Sep 30, 2026 7:37pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 30, 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 Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

The change rebuilds API reference pages from a new schema pin. Public page content should stay the same. The plan checks API page loads, API not-found counts, and production error events. An issue escalates when API page loads drop or not-found counts or errors rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The build fetches OpenAPI from GitHub SHA e9ca0c8b instead of 01ea119. Product API pages under /api/ rebuild from that pin. The OpenAPI document in that commit did not change. Only api_ownership_stats_dont_modify.json changed. Rendered endpoint pages should match the current pages. sentry-docs must deploy for those pages to go live. develop-docs ships the same commit from shared src/ but does not generate OpenAPI pages.

Risk

A missing or invalid schema file fails the product-docs build and blocks the ship. A schema that parses with empty paths omits API pages from static generation. Those URLs then 404. A broken shared bundle can also fail develop-docs even though that site does not render these pages.

Intended effect

No new endpoint page appears. The pin worked when API page loads continue after the new release is live. The effect is absent when other page loads continue and API page loads fall near zero.

Signal Baseline Window Rule Source
docs.page.load counter with page_type:api and environment:production 1084 counts. 5.6% of 19431 site loads 2026-09-29T19:27Z to 2026-09-30T19:27Z Hold near 1084 counts and a 5-6% share of site loads. Absent if API loads fall below 500 while site loads stay near 19431 Sentry org sentry project docs. Query metric.name:docs.page.load AND metric.type:counter AND page_type:api AND environment:production. Field sum(value,docs.page.load,counter,-)

Regression watch

A bad pin can drop API routes or crash the shared app. Watch API not-found counts, site error events, and total page loads. Next.js names the route /:path*?, so do not filter errors by transaction /api/.

Known noise on /:path*? includes Algolia fetch failures, kapa.ai fetch failures, and reCAPTCHA timeouts. Those issues already fire at this baseline. Do not treat them as new unless their rate doubles.

Signal Baseline Window Rule Source
docs.page.not_found counter with requested_path:api* and environment:production 9 counts. 0.8% of 1084 API page loads 2026-09-29T19:27Z to 2026-09-30T19:27Z Hold near 9 counts. Detected if a matching 24h window exceeds 20 Sentry org sentry project docs. Query metric.name:docs.page.not_found AND metric.type:counter AND requested_path:api* AND environment:production. Field sum(value,docs.page.not_found,counter,-)
Error events with environment:production 112 events. 0.58% of 19431 site loads. 100 events on transaction /:path*? 2026-09-29T19:27Z to 2026-09-30T19:27Z Hold near 112 events and 0.5-0.7% of site loads. Detected if a matching 24h window exceeds 200 events Sentry org sentry project docs. Query environment:production. Field count()
docs.page.load counter with environment:production 19431 counts 2026-09-29T19:27Z to 2026-09-30T19:27Z Hold near 19431 counts. A drop with API loads is a site outage, not only a missing API page Sentry org sentry project docs. Query metric.name:docs.page.load AND metric.type:counter AND environment:production. Field sum(value,docs.page.load,counter,-)

Not observable

The running app does not emit the schema SHA. Page body text versus the OpenAPI file is not in telemetry. Hourly seasonality for API loads is unknown. Only a 24h sum was measured. Pageload spans with transaction:"*/api/*" returned 0 because the route name is /:path*?. develop-docs error events were not queried.

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 639dfadd Deployed Sep 30, 2026 by vercel[bot]
Preview – develop-docs — 639dfadd Deployed Sep 30, 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