Skip to content

Bump API schema to 3bfc6ce3 - #20222

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit b64456f into master Oct 23, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-3bfc6ce3 branch October 23, 2026 23:01
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 23, 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 23, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, not-found events on those paths, client errors, and load latency. An issue escalates when not-found events rise or those pages stop loading.

Monitoring in production

Services: sentry-docs, develop-docs.

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

Plan

What changed

API reference pages now build from schema commit 3bfc6ce3. That commit is release 0.401.0. The OpenAPI document did not change from the prior pin 7b9f8d9b. Requests to /api/ category and endpoint pages keep the same documented operations. sentry-docs must deploy before those pages update. develop-docs also deploys this commit because it shares src/. develop-docs does not serve OpenAPI API pages.

Risk

A bad schema can drop or rename API endpoint slugs. Readers then hit not-found pages for old URLs. A schema fetch or parse failure fails the sentry-docs production build. Shared src compiles into develop-docs. That site does not render these API pages.

Intended effect

The pin is live when API reference pages keep loading at the pre-ship share. Do not expect new endpoints. The OpenAPI body did not change. absent looks like the API page-load share falling below the band while total docs page loads hold.

Signal Baseline Window Rule Source
docs.page.load with page_type api, as a share of all docs.page.load 4.5-5.2% 2026-10-21T23:01:41Z to 2026-10-23T23:01:41Z hold the band Sentry org sentry, project docs, environment production

Last 24h was 836 of 16059 loads. Prior 24h was 789 of 17534 loads. Hold that share. A drop below 4.5% with steady total loads is absent.

Regression watch

The change can hide old API slugs and raise client errors on remaining API pages.

Signal Baseline Window Rule Source
docs.page.not_found on requested_path api*, as a share of API loads plus not-found 1.3-1.8% 2026-10-21T23:01:41Z to 2026-10-23T23:01:41Z hold or stay below the band Sentry org sentry, project docs, environment production
error events with url /api/, as a share of API docs.page.load 0.8-1.2% 2026-10-21T23:01:41Z to 2026-10-23T23:01:41Z hold or stay below the band Sentry org sentry, project docs, environment production
p95 duration for pageload and navigation on url.path /api/* 7270-7360ms 2026-10-22T23:01:41Z to 2026-10-23T23:01:41Z hold the band Sentry org sentry, project docs, environment production

Last 24h not-found share was 15 of 851 API loads plus not-found. Prior 24h was 10 of 799. Last 24h error share was 10 of 836 API loads. Prior 24h was 6 of 789. Last 24h p95 was 7355ms on 820 spans. Last 2d p95 was 7272ms on a broader url filter. Escalate if not-found or error share rises above the band. Escalate if p95 rises above 7360ms.

Last 24h not-found counts by requested_path were api/alerts 6, api/events 4, api/projects 3, api/discover 1, and api/monitors 1. Treat a new path at similar volume as a regression. If one of those paths jumps well above its 24h count, inspect that slug first.

Not observable

Pageload spans on /api/ do not set http.response_status_code. Server 5xx on those pages is not measurable there. Pageload span.status error share was 6.3% in the last 24h only. The prior 24h for that share is missing. Live pages do not expose the schema SHA. Per-path API not-found counts for the prior 24h were not measured.

@cursor

cursor Bot commented Oct 24, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API reference pages kept loading after the ship, and no related failure rose.

This branch was successfully deployed

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