Skip to content

Bump API schema to 1ef2ab27 - #20104

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 20, 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 20, 2026 12:03pm UTC
sentry-docs Ready Ready Preview Oct 20, 2026 12:03pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit a01d830 into master Oct 20, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-1ef2ab27 branch October 20, 2026 11:56
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 20, 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 20, 2026 •

Copy link
Copy Markdown
Contributor

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

Rollout complete

Services: sentry-docs.

Plan

What changed

The API reference page for Retrieve an Organization's AI Conversation now documents three new cost fields. Those fields are cacheReadCost, cacheWriteCost, and reasoningCost on stats and usageByModel. The page path is /api/explore/retrieve-an-organizations-ai-conversation/. sentry-docs must deploy before this content is live. The build fetches OpenAPI SHA 1ef2ab2770f6c455aec8462cf284008426679e42 and prebuilds static pages. develop-docs also rebuilds shared src. That site does not serve API reference pages.

Risk

A broken schema can drop API reference pages from the static build. Users then see 404s on /api/ routes, especially /api/explore/. An unexpected schema shape can also throw in the shared API page renderer.

Intended effect

This change updates documented response fields. Production metrics cannot show those field names on the live page. Treat intended_effect as unknown from telemetry. absent looks like the live page still omits cacheReadCost, cacheWriteCost, and reasoningCost. The changed page had no measured docs.page.load events in the sampled 24h window.

Regression watch

A bad schema would first show as missing API pages or new client errors on /api/ paths. Watch the whole API section and the explore slice. The changed endpoint itself has no load traffic to watch.

Signal Baseline Rule Source
API page loads. docs.page.load with page_type api 736-801 loads per 24h. Prior 24h was 736. Latest 24h was 801. 48h sum was 1537 Hold in this band. A fall toward zero means API pages did not generate Sentry org sentry, project docs. Query page_type:api environment:production. Windows 2026-10-18T11:57Z to 2026-10-19T11:57Z and 2026-10-19T11:57Z to 2026-10-20T11:57Z
API 404 share. docs.page.not_found with requested_path api* over API visits 0.9-1.6%. 7 not_found in prior 24h. 13 in latest 24h. 20 in 48h Hold in this band. Rise above the band if API pages went missing Sentry org sentry, project docs. Query requested_path:api* environment:production. Same 24h windows as API page loads
Client errors on /api/ URLs 9 events in latest 24h. Titles include third-party TypeError, kapa fetch, and AbortError noise. Count may vary Hold near this count. Escalate if count rises several times above 9 or new ApiPage errors appear Sentry org sentry, project docs. Errors with environment:production and transaction or url containing /api/. Window 2026-10-19T11:57Z to 2026-10-20T11:57Z
Explore slice 404s. docs.page.not_found with requested_path api/explore 1 event in latest 24h. Only one 24h sample Stay near 0-2 per 24h. A jump on this path is a slice regression Sentry org sentry, project docs. Query requested_path:api/explore environment:production. Window 2026-10-19T11:57Z to 2026-10-20T11:57Z

Not observable

The live HTML for the new cost field names is not in Sentry. The changed endpoint had zero docs.page.load events, so a break of only that page may not move API page loads. A pageload trace query for /api/explore/ timed out. develop-docs has no API reference page signals.

inventarSarah pushed a commit that referenced this pull request Oct 21, 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 — 5db7dcb7 Deployed Oct 20, 2026 by vercel[bot]
Preview – develop-docs — 5db7dcb7 Deployed Oct 20, 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