Skip to content

Bump API schema to 6dac846f - #20019

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 568c26b into master Oct 15, 2026
11 of 13 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-6dac846f branch October 15, 2026 22:24
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 15, 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 15, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API 404s, and client errors on API pages. An issue escalates when API 404s rise or new client errors appear on those pages.

Services: sentry-docs.

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

Plan

What changed

API reference pages now build from OpenAPI schema pin 6dac846fec8b0e31323f2109c4a0011a79e39143.
sentry-docs must deploy before this pin is live.
develop-docs shares this source file.
It does not render API reference pages.
The pin is not reachable there.
The schema repo diff for this pin lists only CHANGELOG.md and package.json.
Page inventory is expected to hold.

Risk

A bad schema can omit or rename endpoint pages.
Readers then see 404s on old API URLs.
A schema shape change can crash the API page renderer.
Users then see a broken endpoint page.
A schema fetch failure at build blocks the whole site deploy.

Intended effect

API pages keep loading after the rebuild.
Do not expect a large shift in API page volume.
absent looks like API page loads falling toward zero while other page types still load.

Signal Baseline Rule Source
docs.page.load with page_type api 775-921 loads per 24h Hold in this band Sentry metrics, org sentry, project docs, query page_type:api environment:production, recent window 2026-10-14T22:25:00Z to 2026-10-15T22:25:00Z was 921, prior window 2026-10-13T22:25:00Z to 2026-10-14T22:25:00Z was 775 from a 48h total of 1696

The prior-day value may differ slightly.
The 48h query used sentry.environment instead of environment.

Regression watch

This pin can break API URL slugs and the API page renderer.
Watch 404s and client errors on those pages.
Third-party fetch errors from Kapa and Algolia already appear in this slice.

Signal Baseline Rule Source
API 404 share, docs.page.not_found with requested_path api-star over docs.page.load with page_type api 0.4-1.2% Hold in this band or fall. A rise above the band is a regression. Sentry metrics, org sentry, project docs, not_found query environment:production requested_path:api*, load query page_type:api environment:production, recent window 2026-10-14T22:25:00Z to 2026-10-15T22:25:00Z was 4 over 921, prior window 2026-10-13T22:25:00Z to 2026-10-14T22:25:00Z was 9 over 775
Client errors with url matching /api/ 2 events per 24h, 0.2% of API page loads Hold near this noise. Escalate on new renderer titles, not Kapa or Algolia fetch failures. Sentry errors, org sentry, project docs, query environment:production url:"*/api/*", window 2026-10-14T22:25:00Z to 2026-10-15T22:25:00Z. Titles were TypeError Failed to fetch from proxy.kapa.ai and NetworkError from insights.algolia.io
Production error events 164-267 events per 24h Hold in this band. The count may vary by day. Sentry errors, org sentry, project docs, query environment:production, recent window 2026-10-14T22:25:00Z to 2026-10-15T22:25:00Z was 267, prior window 2026-10-13T22:25:00Z to 2026-10-14T22:25:00Z was 164 from a 48h total of 431. Most events are on transaction /:path*? and platform-redirect

If API 404s rise and other page types still load, treat the schema pin as the likely cause.

Not observable

Sentry traces search timed out.
Request latency and HTTP status on API pages are unknown.
Prior-day client errors on API URLs were not sampled.
Web vitals on API pages were not queried.

This branch was successfully deployed

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