Skip to content

Bump API schema to a1824c25 - #19829

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 6bad2a0 into master Oct 6, 2026
4 of 6 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-a1824c25 branch October 6, 2026 18:45
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 6, 2026
@github-actions

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

Copy link
Copy Markdown
Contributor

The API reference now shows a new experimental Explore endpoint for dropped events. The plan checks loads of that new page, loads of other API pages, client errors, and not-found counts. An issue escalates when API page errors or not-found counts rise.

Monitoring in production

Services: sentry-docs, develop-docs.

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

Plan

What changed

The OpenAPI pin now points to SHA a1824c25. The API docs now include GET Query Dropped Events under Explore. Requests to /api/explore/query-dropped-events/ now render that experimental operation. The Explore category index also lists this endpoint.

sentry-docs must deploy before this page is live. develop-docs also rebuilds shared src. develop-docs does not generate these OpenAPI pages.

Risk

A schema fetch or parse failure can fail the docs build and block the ship. A render fault on the new operation can throw on that page. The same fault can break the Explore category index. Existing endpoint URLs should stay stable. The schema only added paths.

Intended effect

The new page must appear as a load of Query Dropped Events. This counter is new. The pre-deploy value is zero. confirmed means the counter rises above zero after ship. absent means other API pages still load and this counter stays at zero.

Signal Baseline Rule Source
docs.page.load for api_endpoint:query-dropped-events 0 loads in 2026-10-05T18:47:00Z to 2026-10-06T18:47:00Z Rise above 0 after ship. absent if Explore loads stay near 33 per 24h and this counter stays at 0. Sentry metrics, org sentry, project docs, sentry.environment:production. Query sum(value, docs.page.load) with api_endpoint:query-dropped-events.
pageload and navigation spans for /api/explore/query-dropped-events 0 spans in the same window Rise above 0 after ship. absent if /api/ span volume holds and this URL stays at 0. Sentry traces, project docs. Query span.op:[pageload,navigation] url.full:*query-dropped-events* environment:production. Traces sample at 30%.

Explore category loads are a sibling check. docs.page.load with api_category:explore was 33 in that 24h window. That total may rise a little after the new page is live.

Regression watch

This diff can break the new page, the Explore index, or the whole API tree if apiCategories() throws at build. Watch errors and not-found counts on /api/ pages. Also watch that other API pages keep loading.

Signal Baseline Rule Source
pageload and navigation count for url.full:*/api/* Hourly count 3-103. Active hours 03:00-16:00 UTC were 23-103. Total 950 in 2026-10-05T18:47:00Z to 2026-10-06T18:47:00Z. 24h p95 duration was 5648ms. Hold inside the hourly band. Regression if count stays at 0 through those active hours. Sentry traces, project docs. Query span.op:[pageload,navigation] url.full:*/api/* environment:production. Traces sample at 30%.
docs.page.load with page_type:api 956 loads in the same 24h window. Explore 33. Projects 96. Events 93. Hold near these 24h totals. A drop with the new-page counter at 0 means the API tree did not ship. Sentry metrics, project docs. Query sum(value, docs.page.load) with page_type:api sentry.environment:production. Group by api_category.
Client errors on /api/ URLs 6 events in 24h against 950 spans. Fraction 0.0-0.6%. Types: TypeError 3, UnhandledRejection 2, Error 1. Hold at or below that 24h fraction. Regression if the fraction rises above 0.6% or the 24h count rises well above 6. Sentry errors, project docs. Query http.url:*/api/* environment:production.
docs.page.not_found for paths that contain api 14 counts in the same 24h window. About 1.5% of API page loads. Hold near 14 per 24h. Regression if the 24h count rises well above 14. Sentry metrics, project docs. Query sum(value, docs.page.not_found) with requested_path:*api* sentry.environment:production.

If error counts rise, inspect client exceptions on /api/explore/ first. Then inspect other /api/ category pages.

Not observable

The plan cannot read the rendered field list on the new page. There is no content checksum. The experimental badge is not in telemetry. Hourly p95 duration for /api/ was not returned. Only the 24h p95 is known. develop-docs has no OpenAPI pages, so the intended-effect counter does not apply there.

@cursor

cursor Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The new Query Dropped Events page is live, and other API pages still load without extra errors.

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