Skip to content

Bump API schema to 8f61c4a4 - #20166

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 20fd09e into master Oct 22, 2026
11 of 13 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-8f61c4a4 branch October 22, 2026 08:23
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 22, 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 22, 2026 •

Copy link
Copy Markdown
Contributor

The change updates generated API reference pages with a new condition operator field. The plan checks API page loads, API not-found events, and client errors on API pages. An issue escalates when API pages return not-found or those client errors rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

Custom inbound filter API pages now document an operator field on each filter condition. The conditions text now describes comparison operators such as equals and contains. Request and response examples now include that operator. The pages live under API projects. sentry-docs must deploy before these pages are live. develop-docs also ships the shared source file. It does not render OpenAPI API pages.

Risk

A bad schema can drop API routes at build time. Readers then get not-found pages across the API reference. New conditions markdown can fail at render. That failure is limited to the custom inbound filter pages. develop-docs does not call the OpenAPI loader on the reader path.

Intended effect

This change is a documentation content update. Telemetry cannot show that the operator field appears on the page. Do not treat API page loads as proof that the new text shipped. Absent looks like this. The pages keep loading. The operator field is still missing from the HTML. Record intended effect as unknown unless you inspect page content.

Regression watch

A schema parse failure can remove API routes. Not-found events then rise and API page loads fall. A markdown compile failure can break custom inbound filter pages. New client errors then appear on those URLs.

Signal Baseline Window Rule Source
docs.page.load with page_type api 784 loads. This is 4.2% of 18490 page loads. The 7d mean is 689 loads per day. 2026-10-21T08:24Z to 2026-10-22T08:24Z. 7d mean uses 2026-10-15T08:24Z to 2026-10-22T08:24Z. Hold the 4.2% share of all page loads. Escalate if the share falls below 2% while other page types hold. Sentry org sentry, project docs. Query docs.page.load in production grouped by page_type.
docs.page.not_found on requested_path api* 17 events. 0 events on requested_path api/projects. Total not-found is 85. 2026-10-21T08:24Z to 2026-10-22T08:24Z Hold api/projects at 0. Hold api* near 17. Escalate if api/projects leaves 0 or api* exceeds 34. Sentry org sentry, project docs. Query docs.page.not_found in production grouped by requested_path.
Sentry error events on docs.sentry.io/api/ 12 events. This is 1.5% of 784 API page loads and 4.9% of 244 production errors. 2026-10-21T08:24Z to 2026-10-22T08:24Z Hold near 1.5% of API page loads. Escalate if the count exceeds 24 or a new render error title appears. Sentry org sentry, project docs. Query environment:production http.url:docs.sentry.io/api/
Pageload and navigation failure rate on /api/ URLs 3.7% failure rate on 627 spans. p95 duration is 7995ms. 2026-10-21T08:24Z to 2026-10-22T08:24Z Hold the failure rate near 3.7%. Escalate if it rises above 8%. Sentry org sentry, project docs. Query span.op:[pageload,navigation] url.full:docs.sentry.io/api/* in production.

Not observable

The operator field in page HTML has no telemetry. LCP for API pages returned no values. Custom inbound filter pages had 4 loads in that 24h window. That volume cannot confirm the new text. develop-docs production errors were not measured.

This branch was successfully deployed

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