Skip to content

Bump API schema to 56b2ed5c - #20155

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 21, 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 21, 2026 8:52pm UTC
sentry-docs Ready Ready Preview Oct 21, 2026 8:52pm UTC

Request Review

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

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API path 404s, and client errors on those pages. An issue escalates when API page loads fall or those 404s and errors rise. API pages should keep the same endpoint set.

Services: sentry-docs.

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

Plan

What changed

The production build fetches the OpenAPI document from GitHub at commit 56b2ed5c. That document matches the previous pin at c7d6eef6. API reference pages should keep the same categories and endpoints. sentry-docs must deploy before this change is live. develop-docs compiles this file but does not fetch or render the schema.

Risk

A bad pin can drop API pages from the static build. Readers then receive 404s on former /api/ routes. A fetch or parse failure fails the production build. Other documentation routes should keep working if the build succeeds.

Intended effect

This pin does not add new endpoints. Confirmed means API page loads keep their share of all page loads. Absent means that share falls toward zero while other page loads hold.

Signal Baseline Rule Source
docs.page.load share with page_type:api 3.9-4.5% of all docs.page.load. Current 24h is 832 of 21347. Earlier 24h is about 880 of 19712 from the 48h totals. Hold that share. Do not treat a raw count hold as success if all page loads also fall. Sentry metrics, org sentry, project docs. Query page_type:api on docs.page.load. Compare to unfiltered docs.page.load. Windows 2026-10-20T20:45:00Z to 2026-10-21T20:45:00Z and 2026-10-19T20:45:00Z to 2026-10-20T20:45:00Z.

Hourly API page loads may vary. Use the 24h share, not a single hour.

Regression watch

A dropped or malformed schema shows up as 404s and client errors on API pages. The current client errors are mostly search and browser faults, not render faults. If errors rise, inspect new TypeErrors on API page URLs.

Signal Baseline Rule Source
docs.page.not_found rate with requested_path:api* 1.3-1.7% of API page loads. Current 24h is 11 of 832. Earlier 24h is 15 of about 880. Rise above 1.7% of the same API page-load population. Sentry metrics, org sentry, project docs. Query requested_path:api* on docs.page.not_found. Denominator is docs.page.load with page_type:api. Windows 2026-10-20T20:45:00Z to 2026-10-21T20:45:00Z and 2026-10-19T20:45:00Z to 2026-10-20T20:45:00Z.
production error events with http.url:/api/ 0.8-1.7% of API page loads. Current 24h is 14 of 832. Earlier 24h is 7 of about 880. Rise above 1.7% of the same API page-load population. Sentry errors, org sentry, project docs. Query environment:production AND http.url:/api/. Denominator is docs.page.load with page_type:api. Windows 2026-10-20T20:45:00Z to 2026-10-21T20:45:00Z and 2026-10-19T20:45:00Z to 2026-10-20T20:45:00Z.
docs.page.not_found on all paths 97 in the current 24h and 139 in the earlier 24h from a 48h total of 236. Rise above that 97-139 band while API 404s also rise. Sentry metrics, org sentry, project docs. Unfiltered docs.page.not_found. Same windows as the API 404 signal.

Not observable

Traces for pageload duration on /api/ timed out, so latency has no baseline. Build-time fetch of the GitHub schema has no production signal. Page text is not hashed in telemetry, so spec wording is not measurable.

This branch was successfully deployed

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