Skip to content

Bump API schema to f73faaac - #19867

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit eb2a122 into master Oct 8, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-f73faaac branch October 8, 2026 17:50
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 8, 2026
@github-actions

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

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API-path 404s, and client errors on those pages. An issue escalates when API 404s rise or Monitor API pages stop loading.

Services: sentry-docs.

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

Plan

What changed

The docs build now fetches OpenAPI schema f73faaac. Monitor API pages no longer document alert_rule request and response fields.

sentry-docs must deploy before this change is live. The OpenAPI pin feeds user-docs API routes only. The same commit rebuilds develop-docs, but that site does not render these pages.

The ship is sentry-docs because Production deploys named sentry-docs map to that catalog id, and only that site calls apiCategories.

Risk

A bad schema can omit API routes at build time. Readers then see 404s on former Monitor and other API pages. A client render break on those pages can raise errors while page loads fall.

Intended effect

This change updates generated page content. Telemetry cannot show that alert_rule left the page. Use Crons and Monitor API page loads as a reachability proxy. Absent looks like those loads at zero while other API page loads continue.

Signal Baseline Rule Source
Crons API page loads 20 counts in 24h Hold near 20 per 24h. Absent if 0 while other API loads continue. Sentry metrics docs.page.load page_type:api api_category:crons environment:production, org sentry project docs, 2026-10-07T17:51:00Z to 2026-10-08T17:51:00Z
Monitor API page loads 17 counts in 24h Hold near 17 per 24h. Absent if 0 while other API loads continue. Sentry metrics docs.page.load page_type:api api_category:monitors environment:production, org sentry project docs, same window
All API page loads 4-92 counts per hour. 911 counts in 24h. Hold in the 4-92 hourly band. Absent if the hourly rate falls below 4 while other page types continue. Sentry metrics docs.page.load page_type:api environment:production, org sentry project docs, hourly buckets 2026-10-07T18:00:00Z to 2026-10-08T16:00:00Z

Regression watch

This pin can drop generated /api/ routes or break client render on those pages. Watch 404s and errors on that path, not site-wide docs health. Static API guide pages share the /api/ prefix and are in the same blast radius.

Signal Baseline Rule Source
API-path 404s vs API page loads 26 404s and 911 API loads in 24h, about 2.9%. Hourly 404s 0-1 except 19 at 2026-10-08T01:00:00Z on api/alerts. Hold near 2.9% over 24h. Detected if the 24h ratio rises well above 2.9%, or hourly 404s stay above 1 outside a similar api/alerts spike. Sentry metrics docs.page.not_found requested_path:api* vs docs.page.load page_type:api, both environment:production, org sentry project docs, 2026-10-07T17:51:00Z to 2026-10-08T17:51:00Z
Client errors on /api/ 0 events per hour Hold at zero. Any event is a regression. Sentry errors url.path:/api/* environment:production, org sentry project docs, hourly buckets 2026-10-07T17:00:00Z to 2026-10-08T17:00:00Z
Events and Projects API page loads events 140 counts, projects 64 counts in 24h Hold near those 24h counts. Detected if they fall toward zero while Crons loads hold. Sentry metrics docs.page.load page_type:api api_category:events or projects environment:production, org sentry project docs, same 24h window

If API 404s rise, inspect requested_path for Crons and Monitor slugs first. Then check sibling categories.

Not observable

Whether Monitor API pages still list alert_rule. No page-content probe is connected. Pageload traces are sampled at 30%, so Crons path latency is too sparse for a band.

This branch was successfully deployed

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