Skip to content

Bump API schema to e2dc40b3 - #20140

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit bf18dfc into master Oct 21, 2026
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-e2dc40b3 branch October 21, 2026 15:20
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 21, 2026
@github-actions

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.

@vercel

vercel Bot commented Oct 21, 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 21, 2026 3:40pm UTC
sentry-docs Building Building Preview Oct 21, 2026 3:40pm UTC

Request Review

@cursor

cursor Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

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

Services: sentry-docs.

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

Plan

What changed

The API reference rebuilds from OpenAPI schema e2dc40b3. Timeseries response values gain filled, smoothed, comparisonFilled, and comparisonSmoothed fields. The value and comparisonValue fields become nullable. Those fields show on the SCHEMA tab of the explore timeseries API page. The change is live after sentry-docs deploys. develop-docs builds the same commit. It does not generate /api/ pages.

Risk

A bad schema can fail the static build of every API page. The SCHEMA tab can throw in the browser on API pages. Wrong fields can mislead API consumers. The blast radius is the /api/ reference section.

Intended effect

The SCHEMA tab for Query Explore Events in Timeseries Format must list the new fields. Telemetry does not store that HTML. Use explore API page loads as the proxy. Absent means those loads go to zero while other API pages still load.

The expected traffic shift is none. The schema pin should not change visit volume.

Signal Baseline Window Rule Source
docs.page.load with page_type=api and api_category=explore 24-26 loads per 24h (1.0-1.1/h) 2026-10-19T15:41:17Z to 2026-10-21T15:41:17Z Hold in this band Sentry project docs, environment:production

The timeseries path /api/explore/query-explore-events-in-timeseries-format/ had 5 loads in 2026-10-20T15:41:17Z to 2026-10-21T15:41:17Z. Treat a drop to zero on that path as absent if explore loads also collapse.

Regression watch

This schema is parsed for every API page. A render fault would show as error events on /api/ URLs. Last 24h types were TypeError 6, Event 5, UnhandledRejection 2, and NotSupportedError 1. If the error share rises, inspect TypeError on the SCHEMA tab.

Signal Baseline Window Rule Source
Error events with url:*/api/* 8-14 events per 24h. Last 24h share is 1.8% of 772 page_type=api loads (14/772) 2026-10-19T15:41:17Z to 2026-10-21T15:41:17Z Hold 8-14 per 24h. Hold the share at or below 1.8% Sentry project docs, environment:production url:*/api/*
docs.page.not_found for requested_path api/explore 0. No api/explore row in the last 24h top groups. The smallest shown count was 1 2026-10-20T15:41:17Z to 2026-10-21T15:41:17Z Hold at 0 Sentry project docs, metric docs.page.not_found

page_type=api loads were 772 in 2026-10-20T15:41:17Z to 2026-10-21T15:41:17Z (32/h). Do not call a volume regression without the prior-day rate below.

Not observable

The SCHEMA tab field names are not in telemetry. Prior-day docs.page.load for all page_type=api was not returned. Prior-day loads for /api/explore/query-explore-events-in-timeseries-format/ were not returned. API pageload p95 timed out. The full docs.page.not_found sum for every api path timed out. Top groups in the last 24h showed 11 api-prefixed 404s, mostly api/alerts.

This branch was successfully deployed

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