Skip to content

Bump API schema to 3f13c2e8 - #19842

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit d8a31b7 into master Oct 7, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-3f13c2e8 branch October 7, 2026 17:22
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 7, 2026
@github-actions

github-actions Bot commented Oct 7, 2026

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 7, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API not-found counts, and client errors on those pages. An issue escalates when API page loads fall or those errors rise.

Monitoring in production

Services: sentry-docs, develop-docs.

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

Plan

What changed

API reference pages now rebuild from OpenAPI schema 3f13c2e8. Those pages no longer document a byteSize field beside eventCount. sentry-docs must deploy before this content is live. develop-docs also rebuilds this source file. Developer docs do not serve API reference pages.

Risk

A bad schema can break API page render. Users then see a 404 or a client error. The blast radius is every API reference page that uses the same renderer. The byteSize drop should not change routes.

Intended effect

API reference pages keep loading after the new schema ships. That shows the rebuilt pages serve traffic. Absent looks like API page loads drop toward zero while other page loads hold. Telemetry cannot show that byteSize left the HTML.

Signal Baseline Rule Source
docs.page.load with page_type:api Hourly count 16-72. Share of all docs.page.load is 4.4% (806 of 18346). Hold the hourly count in 16-72. Hold the share near 4.4%. Absent if the share falls toward 0 while all page loads hold. Sentry project docs. environment:production. Window 2026-10-06T17:23:12Z to 2026-10-07T17:23:12Z. Last hour is partial.

Regression watch

This change can break API page render. It can also 404 a page if a slug disappears. The field drop should not remove routes. Algolia and kapa fetch failures already appear on these pages. Treat a new error title or a rise in the h6 TypeError as a regression.

Signal Baseline Rule Source
Client errors with url:/api/ Hourly count 0-3. 24h total 11. Rate 1.4% of API page loads (11 of 806). Titles: Algolia fetch 5, h6 TypeError 3, kapa fetch 2, promise rejection 1. Hold hourly count in 0-3. Hold the 24h rate near 1.4%. Detected if hourly count rises above 3, if the h6 TypeError rises, or if a new title appears. Sentry project docs. environment:production. Window 2026-10-06T17:23:12Z to 2026-10-07T17:23:12Z.
docs.page.not_found with requested_path:api* Hourly count 0-3. 24h total 18. Rate 2.2% of API page loads (18 of 806). Hold hourly count in 0-3. Detected if hourly count rises above 3. Sentry project docs. environment:production. Window 2026-10-06T17:23:12Z to 2026-10-07T17:23:12Z.

Not observable

Whether byteSize left the rendered HTML. Pageload traces do not use /api/ in the transaction name. develop-docs has no API reference page signal.

solnic pushed a commit that referenced this pull request Oct 8, 2026
Co-authored-by: sentry-api-schema-updater[bot] <271575301+sentry-api-schema-updater[bot]@users.noreply.github.com>

This branch was successfully deployed

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