Skip to content

Bump API schema to c97b5635 - #20293

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 54d30eb into master Oct 28, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-c97b5635 branch October 28, 2026 17:50
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 28, 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.

@cursor

cursor Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

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

Rollout complete

Services: sentry-docs.

Plan

What changed

Dashboard widget query examples now include a transformations object. The OpenAPI schema SHA moved from c22a3401 to c97b5635. No API route was added. No API route was removed. This is live after a sentry-docs production deploy. develop-docs shares this source file. It does not build public API pages from this schema, so it is not in services.

Risk

All /api/ docs pages share one OpenAPI fetch at build time. A bad schema can fail that static build. Users then see 404s on API reference pages. A render fault on the new field can break dashboard API pages. The blast radius is every public API docs page.

Intended effect

The new behavior is a transformations object on dashboard widget query examples. Fetch the Create Dashboard API page and look for that field. Absent means the page still omits the field while dashboard API page loads continue.

Signal Baseline Window Source Rule
transformations field on Create Dashboard API page absent 2026-10-28T17:50:46Z GET https://docs.sentry.io/api/dashboards/create-a-new-dashboard-for-an-organization/ Field must appear after deploy. Absent: the example JSON still omits transformations.
docs.page.load with page_type:api and api_category:dashboards 9 per 24h. 118 per 7d. About 9-17 per 24h. 2026-10-27T17:50:46Z to 2026-10-28T17:50:46Z and 2026-10-21T17:50:46Z to 2026-10-28T17:50:46Z Sentry org sentry project docs. Metric docs.page.load. Query sentry.environment:production page_type:api. Group by api_category. Hold in 9-17 per 24h. Absent: 0 over 24h while other api_category values hold.

Regression watch

This diff can drop API docs pages if schema load or slug generation fails. That hits every /api/ page, not only dashboards. Watch 404s on dashboard API pages and on all API pages. Watch client errors on API docs URLs. Ignore the known Event promise rejection noise.

Signal Baseline Window Source Rule
docs.page.not_found with requested_path:api/dashboards 0 in 24h. 0 in 7d. 2026-10-27T17:50:46Z to 2026-10-28T17:50:46Z and 2026-10-21T17:50:46Z to 2026-10-28T17:50:46Z Sentry org sentry project docs. Metric docs.page.not_found. Query environment:production requested_path:api/dashboards Hold at 0.
API docs 404 rate. docs.page.not_found with requested_path:api over docs.page.load with page_type:api 1.34% in 24h. 11 404s over 820 page loads. 1.48% in 7d. 75 404s over 5066 page loads. 2026-10-27T17:50:46Z to 2026-10-28T17:50:46Z and 2026-10-21T17:50:46Z to 2026-10-28T17:50:46Z Sentry org sentry project docs. Metrics docs.page.not_found query environment:production requested_path:api and docs.page.load query sentry.environment:production page_type:api Hold in 1.3-1.5%. Escalate if the rate rises above 1.5%.
docs.page.load with page_type:api 820 per 24h. 5066 per 7d. About 724 per day. 2026-10-27T17:50:46Z to 2026-10-28T17:50:46Z and 2026-10-21T17:50:46Z to 2026-10-28T17:50:46Z Sentry org sentry project docs. Metric docs.page.load. Query sentry.environment:production page_type:api Hold in 720-820 per 24h. Escalate if 24h loads fall below 720 while other docs traffic holds.
error events with http.url:docs.sentry.io/api/ 2-10 per UTC day except 2026-10-25. That day had 295 events. 17 events in 7d are not the Event promise rejection. 304 of 321 events in 7d are title Event: Event Event (type=error) captured as promise rejection. 2026-10-21T00:00:00Z to 2026-10-28T17:50:46Z Sentry org sentry project docs. Errors query environment:production http.url:docs.sentry.io/api/ Hold in 2-10 per 24h after you exclude that Event title. Escalate if other titles rise above 10 per 24h.

Sampled pageload spans for url.path:/api/* over the same 7d were 120, 373, 360, 87, 377, 1183, 307, then 333 on the incomplete last day. 2026-10-26 was a crawl spike. Traces are sampled at 30 percent. Use the metric for the load band above.

Not observable

Sentry metric time series for docs.page.load returned zeros. The load bands use the 24h total and the 7d mean. The transformations field is not a Sentry metric. Pre-ship presence of that field on the live page is absent, as the intended-effect row states. Vercel HTTP 5xx for these static pages is not in this Sentry project. Non-Event error counts for the last 24h only were not split from the Event noise.

@cursor

cursor Bot commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The Create Dashboard API page now includes the transformations field, and API docs 404s and client errors stayed normal.

This branch was successfully deployed

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