Skip to content

Bump API schema to 81eaffc5 - #19837

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

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

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 46afd76 into master Oct 7, 2026
3 of 5 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-81eaffc5 branch October 7, 2026 13:46
@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 change updates generated API reference pages from a newer schema. The plan checks the new conversation stats fields, API page loads, API 404s, and client errors on those pages. An issue escalates when API 404s rise or new client errors appear on those pages.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The docs build now fetches OpenAPI schema 81eaffc54caf1bdf1990b72d013c97c1e8058988.
The Retrieve an Organization's AI Conversation page now documents stats.errors and stats.errorToolNames.
Deploy sentry-docs and develop-docs from this commit.
Only sentry-docs serves these API pages.

Risk

A bad schema can drop API pages at build time or serve 404 after deploy.
Every API reference page shares one schema fetch.
A renderer fault can throw on any API page.
The explore API section is the first place readers see the new fields.

Intended effect

The new schema fields must appear on the live conversation API page.
API page loads that stay high while those strings stay missing means the change is absent.

Signal Baseline Rule Source
New stats fields on the retrieve conversation API page Absent. A GET of /api/explore/retrieve-an-organizations-ai-conversation/ at 2026-10-07T13:47:00Z had no errorToolNames and no stats.errors in the example. The description also lacked those field names. Treat as confirmed when the live page includes errorToolNames and stats.errors. Treat as absent if the old example remains. HTTP GET of that path after deploy
docs.page.load with page_type:api 857 loads from 2026-10-06T13:47:00Z to 2026-10-07T13:47:00Z. 5607 loads from 2026-09-30T13:47:00Z to 2026-10-07T13:47:00Z. That 7 day mean is about 801 per 24h. Hold in the 801-857 band per 24h. This does not prove the new fields. It only shows API pages still render. Sentry org sentry project docs. Query environment:production page_type:api on docs.page.load.

Regression watch

This schema feeds every API reference page.
Watch 404s, API page loads, and client errors on those pages.
Traffic may vary by day of week.

Signal Baseline Rule Source
docs.page.not_found for requested_path:api* 16 counts from 2026-10-06T13:47:00Z to 2026-10-07T13:47:00Z. 75 counts from 2026-09-30T13:47:00Z to 2026-10-07T13:47:00Z. That 7 day mean is about 11 per 24h. Detected if the 24h count rises above 16. Sentry org sentry project docs. Query environment:production requested_path:api* on docs.page.not_found.
docs.page.load with page_type:api 857 loads per 24h and a 7 day mean of 801 per 24h, same windows as above. Explore category was 24 loads in that 24h window. Detected if the 24h total falls below 801, or explore loads collapse while other categories hold. Sentry org sentry project docs. Query environment:production page_type:api on docs.page.load. Group by api_category if volume drops.
Client errors on API docs URLs 12-13 TypeError events from 2026-10-06T13:47:00Z to 2026-10-07T13:47:00Z on URLs that contain /api/. Most were Failed to fetch from kapa.ai or algolia.io. Two were Cannot read properties of undefined (reading 'h6') on events API pages. That is about 0.2% non-fetch errors vs 857 API page loads. Detected if non-fetch errors rise above 2 in 24h. Also detected if a new error title hits /api/explore/ pages. Ignore Failed to fetch from kapa.ai and algolia.io as known noise. Sentry org sentry project docs. Query environment:production url:*\/api\/*.

Not observable

develop-docs does not render OpenAPI pages. This schema has no user-facing signal on that site.
Sentry metrics do not include the new field names. Use the live page GET in Intended effect.

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