Skip to content

Bump API schema to 8302a930 - #19835

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit e48f185 into master Oct 7, 2026
15 of 17 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-8302a930 branch October 7, 2026 11:56
@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 API page loads, API-path errors, and API 404s. An issue escalates when API-path errors rise or API pages return not found.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

Requests to the retrieve AI conversation API docs page now show new example keys. The example uses gen_ai.input.messages and gen_ai.output.messages in place of gen_ai.request.messages and gen_ai.response.text.
sentry-docs must deploy before this example is live. develop-docs also deploys because it shares src/. develop-docs does not render these API pages.

Risk

A bad schema can fail the build or break every API docs page. This diff only renames two keys in one example. User impact is that example unless page slugs change. Slug changes would 404 old API URLs. A shared src/ rebuild can also ship a broken develop-docs bundle.

Intended effect

The example on /api/explore/retrieve-an-organizations-ai-conversation/ must show the new keys. absent means the example still shows gen_ai.request.messages and gen_ai.response.text. Sentry does not record example body text. API page load volume is not proof of the rename.

Signal Band Window Rule Source
Example keys on retrieve AI conversation API page Old keys present 2026-10-07T11:57:00Z After deploy, new keys must replace old keys Live page /api/explore/retrieve-an-organizations-ai-conversation/

Regression watch

This diff can break API page render or drop API routes. Watch API-path errors, API 404s, and API page loads. If API-path errors rise, inspect client exceptions on /api/ pages.

Signal Band Window Rule Source
docs.page.load with page_type:api 16-84 per hour 2026-10-06T12:00:00Z to 2026-10-07T11:00:00Z Hold inside this band. A drop below 16 per hour is a regression. Sentry metrics, org sentry, project docs, environment:production
API-path error rate 1.5% from 13 errors per 888 API page loads 2026-10-06T11:57:00Z to 2026-10-07T11:57:00Z Hold near this 24h rate. A rise above it is a regression. Sentry errors environment:production (url:*/api/* OR http.url:*/api/*), project docs
docs.page.not_found with requested_path:api* 13 per 24h 2026-10-06T11:57:00Z to 2026-10-07T11:57:00Z Hold near 13 per 24h. A rise above it is a regression. Eight of those 404s were api/alerts. Sentry metrics, project docs, environment:production
develop-docs production errors 45 per 24h 2026-10-06T11:57:00Z to 2026-10-07T11:57:00Z Hold near 45 per 24h. A sharp rise is a regression. Sentry errors environment:production, project develop-docs

Not observable

Sentry does not record the example JSON text. Confirm the rename on the live page named above. Hourly p95 for /api/ pageload was not sampled. The 24h p95 was 6424ms over 887 pageload and navigation spans. No load denominator was measured for develop-docs errors.

@cursor

cursor Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages still load with the new example keys.

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