Skip to content

Bump API schema to c22a3401 - #20282

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 6adceb4 into master Oct 28, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-c22a3401 branch October 28, 2026 07:43
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 28, 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 28, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, not-found events on API paths, and client errors on those pages. An issue escalates when API page loads collapse while other pages hold. It also escalates when API not-found events or API-page errors rise.

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 SHA c22a3401. That SHA is schema package 0.415.0. The OpenAPI JSON file did not change in this pin. API reference pages should match the previous pin after deploy.

sentry-docs must deploy before the pin is live. develop-docs also deploys this shared source file. Developer docs do not render API pages. Catalog and Vercel both ship src/ to these two services.

Risk

A missing or invalid schema file fails the production build. Users then lose the API reference tree. Old API URLs would 404 if endpoint slugs changed. This pin does not change the JSON, so slug drift is unlikely. A broken shared rebuild can still raise client errors on both sites.

Intended effect

The pin adds no new metric. Success is API reference pages still loading at the measured share. absent means that share falls toward zero while other page types hold. Developer docs have no queryable API-page effect.

Hold the pooled share in the band. Do not treat a traffic shift that keeps the share as absent.

Signal Baseline Window Rule Source
docs.page.load share with page_type:api over all docs.page.load, environment:production 4.0-4.2% of site page loads. 821 of 19435 loads in the latest 24h. 756 of 18811 loads in the prior 24h. Latest 24h 2026-10-27T07:44Z to 2026-10-28T07:44Z. Prior 24h 2026-10-26T07:44Z to 2026-10-27T07:44Z. Derived from 48h totals. Hold in 4.0-4.2%. absent if the share falls below 1% while total page loads stay in 18800-19400 per 24h. Sentry org sentry, project docs. Metric docs.page.load.

Regression watch

This pin can drop the API tree or 404 old endpoint URLs. It can also break the shared app after rebuild. api/prevent already accounts for 8 of 16 API not-found events. Treat a rise outside that path as more likely schema-slug damage.

Signal Baseline Window Rule Source
docs.page.not_found with requested_path:api*, environment:production, as a share of API docs.page.load 1.9% in the latest 24h. 16 not-found events against 821 API page loads. 22 events in 48h with the broader requested_path:*api* filter. Latest 24h 2026-10-27T07:44Z to 2026-10-28T07:44Z. 48h 2026-10-26T07:44Z to 2026-10-28T07:44Z. Hold in 1.4-1.9% of API page loads. detected if the rate rises above 4% or the 24h count exceeds 32. Sentry org sentry, project docs. Metric docs.page.not_found.
Error events with environment:production and http.url:*/api/* as a share of API docs.page.load 0.3-0.5%. 4 events in the latest 24h. 2 events in the prior 24h. 6 events in 48h. Latest 24h 2026-10-27T07:44Z to 2026-10-28T07:44Z. Prior 24h 2026-10-26T07:44Z to 2026-10-27T07:44Z. Hold in 0.3-0.5%. detected if the rate rises above 1.5% or the 24h count exceeds 12. Sentry org sentry, project docs. Error search environment:production http.url:*/api/*.
Non-API docs.page.load, environment:production 18614 loads in the latest 24h. 18055 loads in the prior 24h. Share 95.8-96.0% of site page loads. Latest 24h 2026-10-27T07:44Z to 2026-10-28T07:44Z. Prior 24h 2026-10-26T07:44Z to 2026-10-27T07:44Z. Hold in 18000-18600 loads per 24h. A drop with API loads still present is a site-wide regression. Sentry org sentry, project docs. Metric docs.page.load excluding page_type:api.
develop-docs production errors over docs.page.load 31 errors and 1780 page loads in 24h. Rate 1.7%. Prior-day split was not sampled. Latest 24h 2026-10-27T07:44Z to 2026-10-28T07:44Z. detected if errors exceed 62 per 24h or page loads fall below 900 per 24h. Sentry org sentry, project develop-docs.

If API not-found events rise, check requested_path for new api/ slugs. If API-page errors rise, check the release on project docs.

Not observable

The schema SHA is not shown on the page, so the pin itself is not queryable. Release 0.415.0 lists no new endpoints. The OpenAPI JSON did not change, so no new-path load signal exists.

API pageload duration has only one 24h sample. p75 was 4853ms. p95 was 12378ms. Count was 313 sampled pageloads. The prior-day split was not taken. Soft-navigation LCP was not queried. Record latency as unknown.

The 48h fleet error count on project docs did not return a usable total. The 24h count was 720. The prior-day fleet error rate is unknown. Record fleet-wide errors as unknown unless the API-URL error row above fires.

The prior-day develop-docs error rate was not sampled. The 24h rate above is the only measured point.

This branch was successfully deployed

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