Skip to content

Bump API schema to d12bf35d - #19843

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit cdcd887 into master Oct 7, 2026
1 of 3 checks passed
@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 Building Building Preview Oct 7, 2026 5:30pm UTC
sentry-docs Building Building Preview Oct 7, 2026 5:30pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-d12bf35d branch October 7, 2026 17:30
@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 page loads, API not-found events, and production errors. An issue escalates when API page loads fall or API not-found events rise. Error volume on the remounted sites is the sibling watch.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The generated API docs now list a 429 Too Many Requests response on one existing endpoint. Build fetches OpenAPI schema SHA d12bf35d26e7e3fe9eacf3a04a034ee1535d693c. sentry-docs and develop-docs must both deploy. Only the public docs site serves generated API pages.

Risk

A bad schema can drop API pages or break the response status buttons. Users then see not-found pages or a broken endpoint page. The shared source tree also remounts the developer docs site.

Intended effect

The new 429 text is not a metric. Use API page loads as the same-path proxy that the schema still built those pages. Absent looks like API page loads near zero while other page loads stay in band.

Signal Baseline Rule Source
docs.page.load with page_type:api and environment:production 11-72 loads per hour. 805 loads in 24h. 4.4% of 18356 total page loads. Hold in the hourly band after deploy. Confirm the 24h share stays near 4.4%. Treat as absent if this counter stays near zero while total docs.page.load stays near 18356 per 24h. Sentry org sentry project docs. Metric docs.page.load. Query page_type:api environment:production. Window 2026-10-06T17:00:00Z to 2026-10-07T17:00:00Z.

Regression watch

This diff can drop or break API endpoint pages. The shared src/ remount can also raise errors on both sites. Known noise includes Algolia and Kapa fetch TypeErrors. Do not treat those fetch failures as this change unless they spike with API page loads.

Signal Baseline Rule Source
docs.page.not_found with environment:production and requested_path:api* 18 events in 24h. 2.2% of the 805 API page loads. api/alerts was 10 of those events. Hold at or below this 24h rate. Escalate if the API not-found share rises above 2.2% of API page loads. Sentry org sentry project docs. Metric docs.page.not_found. Query environment:production requested_path:api*. Window 2026-10-06T17:00:00Z to 2026-10-07T17:00:00Z.
Production errors on project docs 1-24 events per hour. 143 events in 24h. 0.78% of 18356 page loads. Hold in the hourly band. Escalate if the hourly count stays above 24. Sentry org sentry project docs. Errors dataset. Query environment:production. Window 2026-10-06T17:00:00Z to 2026-10-07T17:00:00Z.
Production errors on project develop-docs 0-4 events per hour. 33 events in 24h. Hold in the hourly band. Escalate if the hourly count stays above 4. Sentry org sentry project develop-docs. Errors dataset. Query environment:production. Window 2026-10-06T17:00:00Z to 2026-10-07T17:00:00Z.

If API not-found events rise, check whether generateStaticParams omitted an endpoint slug. If docs errors rise, check ApiPage and the response status buttons.

Not observable

The new 429 response text has no metric. Error events cannot be sliced to /api/ by transaction. Transaction name is /:path*?. Hourly p95 for /api/ pageloads was not sampled. The exact endpoint path is not identified from the three-line schema patch.

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 — f54fba30 Deployed Oct 7, 2026 by vercel[bot]
Preview – develop-docs — f54fba30 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