Skip to content

Bump API schema to 3099d249 - #19844

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

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

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 6:01pm UTC
sentry-docs Ready Ready Preview Oct 7, 2026 6:01pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 811709c into master Oct 7, 2026
16 of 18 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-3099d249 branch October 7, 2026 17:53
@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 timeseries API page loads, API 404s, and client errors on those pages. An issue escalates when the timeseries page stops loading or those 404s or errors rise.

Services: sentry-docs.

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

Plan

What changed

Requests to the explore timeseries API docs page now show updated example payloads. Those examples include incomplete timeseries buckets and ingestion metadata. sentry-docs must deploy before this is live. develop-docs rebuilds from this commit but does not serve OpenAPI pages.

Risk

A renderer crash on the new example JSON would break that page for readers. A schema parse failure could drop many API docs pages. Blast radius is the API catalog. The explore timeseries page is first.

Intended effect

The rebuilt schema is live when that timeseries page still records loads. Absent is zero loads on that page while other API pages still load.

Signal Baseline Rule Source
docs.page.load with api_endpoint:query-explore-events-in-timeseries-format environment:production 14 loads per 24h. 1.7% of API page loads. Window 2026-10-06T17:54:00Z to 2026-10-07T17:54:00Z Hold near 14 per 24h. Absent if 0 while page_type:api stays in the hourly band below Sentry org sentry project docs
docs.page.load with api_category:explore page_type:api environment:production 24 loads per 24h. Same window Hold near 24 per 24h. Absent if this holds and the endpoint row is 0 Sentry org sentry project docs
docs.page.load with page_type:api environment:production 16-72 loads per hour in complete hours. 801 per 24h. Same window Hold 16-72 per hour. This row only proves the catalog still serves. It does not prove the new example text Sentry org sentry project docs

Regression watch

This diff could 404 a renamed API path or crash the example renderer on the new JSON. Watch 404s and errors on the API catalog, not only the success count.

Signal Baseline Rule Source
docs.page.not_found with requested_path:api* environment:production 18 per 24h. Window 2026-10-06T17:54:00Z to 2026-10-07T17:54:00Z. api/explore was 0. api/alerts was 10 Detected if the 24h total rises above 18 or api/explore is not 0 Sentry org sentry project docs
Error events with URL or transaction matching query-explore-events-in-timeseries-format or /api/explore/ environment:production 0 per 24h. Same window Detected if count is not 0 Sentry org sentry project docs
docs.page.load with api_category:explore environment:production 24 per 24h. Same window Detected if this falls while other page_type:api categories hold Sentry org sentry project docs

If 404s rise, check whether explore slugs vanished from the rebuilt catalog. If errors appear, check ApiExamples JSON render on that page.

Not observable

The new example fields themselves are not in telemetry. The executor cannot confirm incompleteReason or meta.ingestion from metrics. Pageload span latency for /api/ transactions returned 0 spans in this window. Transaction names do not match those paths. Traces are sampled at 30%. Soft navigations may hide page URLs. Put latency unknown unless a later span query matches.

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