Skip to content

Bump API schema to 7e86985c - #20036

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

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

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API 404s, and client errors on API URLs. An issue escalates when API page loads fall or those errors rise. The schema pin does not add new API page content.

Services: sentry-docs.

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

Plan

What changed

The production build fetches OpenAPI schema 7e86985c instead of 323c73b4.
That schema commit changes only rpc_method_schema.json.
The site reads openapi-derefed.json, which is unchanged at the new SHA.
API reference pages keep the same endpoint list and text.
sentry-docs must deploy before this pin is live.
develop-docs builds the same repository but does not call apiCategories.
This plan watches sentry-docs only.

Risk

A bad schema file can fail the production build.
A parse error can drop API category pages from static generation.
Users then get 404s on /api/ paths.
A renderer crash can throw on those pages.
The blast radius is the API reference tree.

Intended effect

The pin does not change API reference content.
No new endpoint page appears.
There is no new counter for this SHA.
Treat intended effect as confirmed when the API page load share holds in band.
Treat it as absent when that share falls toward zero and other page types hold.

Signal Baseline Rule Source
API page load share 4.2-5.2% of docs.page.load Hold in band. Absent if the share falls toward 0% Sentry org sentry project docs. Metric docs.page.load. Query page_type:api environment:production over environment:production. Window 2026-10-14T16:51:00Z to 2026-10-15T16:51:00Z was 830/19725 = 4.2%. Window 2026-10-15T16:51:00Z to 2026-10-16T16:51:00Z was 854/16520 = 5.2%

Regression watch

A broken schema can 404 API pages or throw in the client renderer.
Watch API 404s, API URL errors, and the site error rate on the same ship.
If the error rate rises, inspect client errors on /:path*? for API renderer failures.

Signal Baseline Rule Source
API 404 share 0.48-0.82% of API page loads Hold in or below band. Detected above 0.82% Sentry org sentry project docs. Metric docs.page.not_found query requested_path:api* sentry.environment:production over docs.page.load query page_type:api environment:production. Window 2026-10-14T16:51:00Z to 2026-10-15T16:51:00Z was 4/830 = 0.48%. Window 2026-10-15T16:51:00Z to 2026-10-16T16:51:00Z was 7/854 = 0.82%
Client errors on API URLs 0.35% of API page loads (3 events) Hold near 0.35%. Detected if the share rises above 1% Sentry org sentry project docs. Errors query environment:production http.url:*/api/*. Window 2026-10-15T16:51:00Z to 2026-10-16T16:51:00Z was 3 events. Prior-day URL slice was not measured
Site error rate 0.65-1.46% of page loads Hold in or below band. Detected above 1.46% Sentry org sentry project docs. Errors query environment:production over docs.page.load query environment:production. Window 2026-10-15T16:51:00Z to 2026-10-16T16:51:00Z was 107/16520 = 0.65%. Window 2026-10-14T16:51:00Z to 2026-10-15T16:51:00Z was 287/19725 = 1.46%

Not observable

The SHA string is not in production telemetry.
Page HTML is not compared to the prior schema.
Pageload traces share transaction /:path*? and are sampled at 30%.
URL-sliced client errors were measured for 24h only.

This branch was successfully deployed

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