Skip to content

Bump API schema to 969b8a53 - #20177

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit cdaff3a into master Oct 22, 2026
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-969b8a53 branch October 22, 2026 15:15
@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.

@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 Building Building Preview Oct 22, 2026 3:15pm UTC
sentry-docs Building Building Preview Oct 22, 2026 3:15pm UTC

Request Review

@cursor

cursor Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API-path 404s, and errors on those pages. An issue escalates when API-path 404s rise or those errors rise.

Services: sentry-docs.

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

Plan

What changed

API reference pages that document filter comparison operators now list cidr and not_cidr. Those pages go live after the sentry-docs production deploy. This change does not add or remove API docs routes. The develop-docs project rebuilds this repo and does not load the OpenAPI schema.

Risk

A failed schema fetch or parse fails the production build. A shipped bad schema can omit API pages from the static tree. Users then hit 404s on API reference paths. A render fault in the enum list can throw on those pages. This bump only adds two enum values and description text.

Intended effect

The new cidr and not_cidr choices are page text. Telemetry cannot read that text. The docs.page.load counter with page_type api remaining in band shows the rebuilt API pages still load. Absent looks like that counter falling below the band while other page types hold.

Signal Baseline Rule Source
docs.page.load with page_type api 776-845 counts per 24h. Prior day 776. Last day 845. Hold in band. Sentry metrics, org sentry, project docs, environment production. Windows 2026-10-20T15:16Z to 2026-10-21T15:16Z and 2026-10-21T15:16Z to 2026-10-22T15:16Z. Query metric.name docs.page.load grouped by page_type.

Regression watch

This diff can drop API pages from the static tree or throw while the enum list renders. Watch API-path 404s and errors on API URLs. Current 404 hot spots are api/alerts, api/organizations, and api/events. A jump on all api paths is the regression. Those three paths holding is not proof the change worked.

Signal Baseline Rule Source
docs.page.not_found with requested_path api* 15-18 counts per 24h. Rate 1.9-2.1% of API loads plus API 404s. Prior day 15 of 791. Last day 18 of 863. Hold in band. Escalate if the rate rises above 2.1%. Sentry metrics, org sentry, project docs, environment production. Windows 2026-10-20T15:16Z to 2026-10-21T15:16Z and 2026-10-21T15:16Z to 2026-10-22T15:16Z. Query metric.name docs.page.not_found requested_path api*.
Error events with url /api/ Last 24h 4 events on 845 API loads, rate 0.47%. Last 48h 17 events on 1621 API loads, rate 1.05%, with a broader URL filter. Band 0.47-1.05%. Hold in band. Escalate if the 24h rate rises above 1.05%. Known noise includes Algolia fetch failures and TypeError reading xS. Sentry errors, org sentry, project docs, environment production. Last 24h window 2026-10-21T15:16Z to 2026-10-22T15:16Z, query environment:production AND url:"/api/". Last 48h window 2026-10-20T15:16Z to 2026-10-22T15:16Z, query environment:production url:/api/.

If the 404 rate rises, check whether whole api category pages are missing. That pattern means the OpenAPI tree did not build.

Not observable

The cidr and not_cidr text on the API pages is not in telemetry. The prior-day error count with the exact url /api/ filter was not measured. The 48h error query used a different URL pattern.

This branch was successfully deployed

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