Skip to content

Bump API schema to ac530307 - #19880

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 9, 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 9, 2026 11:30am UTC
sentry-docs Ready Ready Preview Oct 9, 2026 11:30am UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 7713329 into master Oct 9, 2026
11 of 13 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-ac530307 branch October 9, 2026 11:23
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 9, 2026
@github-actions

github-actions Bot commented Oct 9, 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 9, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, the conversation endpoint page, API path 404s, and error events. An issue escalates when API pages 404, 5xx responses appear, or error events rise.

Services: sentry-docs.

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

Plan

What changed

The Explore API page for Retrieve an Organization's AI Conversation now documents three stats fields. Those fields are cacheReadTokens, cacheWriteTokens, and reasoningTokens. The page text now says inputTokens includes cache-read and cache-write tokens.

sentry-docs must deploy a build that fetches schema SHA ac530307. The pages bake that schema at build time. develop-docs shares this source file and will rebuild. It does not generate API reference pages, so it is not in services.

Risk

A broken schema can fail the static build or drop generated API pages. Users then see 404s under /api/. A render crash on the conversation page can throw client errors. Wrong field docs mislead API consumers. The blast radius is generated API reference pages. Platform SDK docs should not change.

Intended effect

Sentry does not record the new stats field names on the page. Use traffic to that page as a proxy that the page still builds and serves. Absent looks like this: traces for the conversation page stay at zero, while other API page loads continue.

Signal Baseline Rule Source
Conversation page requests 27 spans in 24h, about 1.1 per hour. p95 803ms. Window 2026-10-08T11:24:00Z to 2026-10-09T11:24:00Z. Hold above zero over 24h. A zero count with other API loads still present is absent. Sentry traces, project docs. Query environment:production http.url:*api/explore/retrieve-an-organizations-ai-conversation*
API page loads 938 counts in 24h. Hourly band 2-92. Night hours may sit at the low end. Same window. Hold inside 2-92 per hour. A 24h collapse toward zero while platforms loads hold is absent. Sentry metrics docs.page.load, query metric.name:docs.page.load AND page_type:api AND environment:production

Regression watch

This diff can drop or break generated API pages. Watch 404s and errors on that path. Also watch sibling API volume so a site-wide dip is visible.

Signal Baseline Rule Source
API path 404s Total docs.page.not_found 446 in 24h. Top API group was api/alerts at 7. Same window. Detected if api/explore or other api/ paths enter the top groups, or api/alerts rises well above 7. Sentry metrics docs.page.not_found, query metric.name:docs.page.not_found AND environment:production, group by requested_path
HTTP 5xx on API http.server spans 0 in 24h. Same window. Detected if the count rises above 0. Sentry traces, project docs. Query span.op:http.server AND http.status_code:>=500 AND http.url:*api* AND environment:production
Error events 164 in 24h. Hourly band 0-22. Top titles were Algolia fetch failures and third-party script noise. Same window. Detected if the hourly count stays above 22, or new API page renderer errors appear. Sentry errors, project docs, query environment:production
Explore API family p95 Hourly p95 81-2110ms. 24h p95 980ms. Same window. Detected if hourly p95 stays above 2110ms. Sentry traces, project docs. Query environment:production http.url:*api/explore/*

Not observable

The new stats field names on the conversation API page are not in Sentry. Open /api/explore/retrieve-an-organizations-ai-conversation/ after deploy to confirm cacheReadTokens, cacheWriteTokens, and reasoningTokens appear.

This branch was successfully deployed

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