Skip to content

Bump API schema to 658c82e5 - #19816

Merged
sentry-api-schema-updater[bot] merged 1 commit into
masterfrom
bot/bump-api-schema-to-658c82e5
Oct 5, 2026
Merged

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

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

github-actions Bot commented Oct 5, 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 5, 2026 •

Copy link
Copy Markdown
Contributor

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

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

API reference pages now document max_runtime as 10080 minutes. The old text used 40320 minutes. The new text also states a 7 day maximum. This appears on crons monitor API pages that list the max_runtime body field. sentry-docs must deploy before this change is live. develop-docs also deploys because the shared src tree changed. develop-docs does not render these API reference pages.

Risk

Wrong max_runtime text misleads users who set cron monitor limits. A broken schema can fail the static site build. A changed API slug can 404 old API pages. This diff only edits a field maximum and its description. New 404s from renamed endpoints are unlikely.

Intended effect

The new description text is not in telemetry. Use API page load share as the proxy that pages still generate. Absent means crons API page spans fall to zero while other API pages continue.

Signal Baseline Rule Source
API share of docs.page.load 4.0 percent. 895 API loads and 22548 total loads. Window 2026-10-04T23:16:00Z to 2026-10-05T23:16:00Z Hold near 4.0 percent. A fall toward 0 percent is absent Sentry metrics project docs. Query: metric.name:docs.page.load AND page_type:api AND environment:production. Denominator: metric.name:docs.page.load environment:production
Crons API pageload and navigation spans 20 spans. Window 2026-10-04T23:16:00Z to 2026-10-05T23:16:00Z Stay above zero Sentry traces project docs. Query: environment:production AND (span.op:pageload OR span.op:navigation) AND url:api/crons

Regression watch

A bad schema can break API page render or the whole static build. Watch API 404s, API URL errors, and site-wide errors.

Signal Baseline Rule Source
API path 404 rate 1.3 percent. 12 docs.page.not_found with requested_path api* and 895 API page loads. Window 2026-10-04T23:16:00Z to 2026-10-05T23:16:00Z Hold near 1.3 percent. Rise above 3 percent is a regression Sentry metrics project docs. Query: metric.name:docs.page.not_found AND requested_path:api* AND environment:production
API URL error ratio 0.9 percent. 8 errors and 873 API pageload or navigation spans. Window 2026-10-04T23:16:00Z to 2026-10-05T23:16:00Z Hold near 0.9 percent. The 24h error sample is small. Rise above 2 percent may be a regression Sentry errors project docs. Query: environment:production url:/api/. Spans: environment:production (span.op:pageload OR span.op:navigation) http.url:/api/
Site-wide error count Hourly 1-18 errors. 138 errors in 24h. 0.61 percent of 22548 page loads. Window 2026-10-04T23:16:00Z to 2026-10-05T23:16:00Z Hold inside 1-18 errors per hour. Rise above 18 per hour is a regression Sentry errors project docs. Query: environment:production

Not observable

The max_runtime wording on the live pages is not in telemetry. The pinned schema SHA is not in telemetry. develop-docs has no API-schema path signal.

@cursor

cursor Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages still load on the new release, and 404s did not rise.

This branch was successfully deployed

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