Skip to content

Bump API schema to 2ae04130 - #20000

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 15, 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 15, 2026 2:22pm UTC
sentry-docs Ready Ready Preview Oct 15, 2026 2:22pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 82ab95f into master Oct 15, 2026
1 check was pending
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-2ae04130 branch October 15, 2026 14:17
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 15, 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 15, 2026 •

Copy link
Copy Markdown
Contributor

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

Services: sentry-docs.

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

Plan

What changed

The build now fetches the public API OpenAPI document from git SHA 2ae04130. Category and endpoint pages under /api/ are generated from that document at build time. The prior pin was a GitHub rate-limit error string, not a commit SHA. This change is live after the sentry-docs production deploy. develop-docs rebuilds from the same repo but does not call apiCategories, so it does not serve this pin.

The schema commit at that SHA is SDK client contract work. It did not list openapi-derefed.json in its changed files. Page copy may match the last good pin. The checkable effect is that /api/ pages still generate and load.

Risk

A bad or empty OpenAPI document omits /api/ routes from the static build. Those URLs then 404. Changed operation titles change slugs and break old links. A parse throw fails the build and does not ship. The catch-all page imports the resolver, so a bad docs deploy can also break non-API pages.

Intended effect

API documentation pages must keep loading after the new pin. absent looks like page_type:api load volume falling toward zero while other page types still load.

Signal Baseline Window Rule Source
API share of docs.page.load 3.8% in 24h, 4.0% in 7d. Counts: 735 of 19335 in 24h, 5045 of 126484 in 7d. Daily mean from 7d is about 721. 2026-10-14T14:18Z to 2026-10-15T14:18Z and 2026-10-08T14:18Z to 2026-10-15T14:18Z Hold in the 3.8-4.0% share band. Confirmed if the share stays in band. Absent if the share falls toward 0% while total loads hold. Sentry org sentry, project docs, environment production. Query: metric.name:docs.page.load AND environment:production, group by page_type.

Regression watch

A wrong schema can drop or rename /api/ pages. It can also ship a broken docs client to every page. Watch API not-found events, API-page errors, API RSC fetch failures, and platform page loads. RSC fetch failures already fire on home and platform pages from an existing TypeError. Do not treat that noise alone as this change.

Signal Baseline Window Rule Source
API not-found share of API loads 0.68% in 24h, 1.27% in 7d. Counts: 5 not-found vs 735 API loads in 24h, 64 vs 5045 in 7d. 2026-10-14T14:18Z to 2026-10-15T14:18Z and 2026-10-08T14:18Z to 2026-10-15T14:18Z Hold in the 0.68-1.27% band. Detected if the share rises well above 1.27% while API loads hold. Sentry org sentry, project docs, environment production. Not-found query: metric.name:docs.page.not_found AND environment:production AND requested_path:*api*. Pair with docs.page.load page_type:api.
Error events on /api/ URLs 2 events in 24h, 318 in 7d, about 45 per day in the week. The last day is quiet versus the week. 2026-10-14T14:18Z to 2026-10-15T14:18Z and 2026-10-08T14:18Z to 2026-10-15T14:18Z Do not treat a return to about 45 per day as this change alone. Detected if the 24h count jumps above that weekly daily mean, or if errors rise with API not-found events. Sentry org sentry, project docs. Query: environment:production AND (url:"*/api/*" OR transaction:"*/api/*").
RSC fetch failures on /api/ URLs 317 API-URL logs in 24h vs 5158 site-wide, a 6.1% share. This is existing TypeError noise. 2026-10-14T14:18Z to 2026-10-15T14:18Z Hold near a 6.1% share of site RSC failures. Detected if the API share of these logs rises while API loads fall or not-found events rise. Sentry org sentry, project docs, environment production. API query: environment:production AND message:"*Failed to fetch RSC payload for https://docs.sentry.io/api*". Site query: environment:production AND message:"*Failed to fetch RSC payload*".
Platform page loads 48% of 24h loads. Counts: 9293 in 24h, 71343 in 7d, about 10192 per day. 2026-10-14T14:18Z to 2026-10-15T14:18Z and 2026-10-08T14:18Z to 2026-10-15T14:18Z Hold near the 48% share and the 9.3k-10.2k per-day band. A drop with API loads points at a whole-site deploy break. Sentry org sentry, project docs, environment production. Query: metric.name:docs.page.load AND environment:production, page_type:platforms.

Not observable

The OpenAPI path and endpoint delta versus the last good production pin is not measured here. Pageload p95 for /api/ returned no rows. Server http.server spans for /api/ counted 0 because pages are prebuilt and served from the CDN.

sergical added a commit that referenced this pull request Oct 15, 2026
…ng (#20001)

## DESCRIBE YOUR PR

The Bump API Schema SHA workflow got rate-limited by the GitHub API and
wrote the error body (`{"message":"API rate limit exceeded for ..."}`)
into `SENTRY_API_SCHEMA_SHA`. It then admin-merged the change
([#19999](#19999)). That
broke `master` for about 10 minutes, until the next run
([#20000](#20000)) replaced
it with a real SHA.

The workflow called the commits API without authentication and never
checked what came back. It now:

- Sends the GitHub App token it already creates. That token has access
to `sentry-api-schema`, so the request gets the much higher
authenticated rate limit.
- Uses `curl --fail`, so an HTTP error fails the job instead of
returning the error body.
- Fails the job unless the response is a 40-character hex SHA, so
nothing else gets written into the file or merged.

It also fixes `-sSl` to `-sSL`. Lowercase `-l` is curl's FTP
`--list-only` flag; `-L` follows redirects, which is what was meant.

## IS YOUR CHANGE URGENT?

- [x] No deadline: Not urgent, can wait up to 1 week+

## PRE-MERGE CHECKLIST

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

<!-- junior-request-attribution:start -->
via @sergical.
<!-- junior-request-attribution:end -->

<!-- junior-session-footer:start -->
<!-- junior-conversation-id:slack%3AC8H0BQRDJ%3A1792070558.468179 -->

--

[View Junior
Session](https://junior-prod.sentry.dev/conversations/slack%3AC8H0BQRDJ%3A1792070558.468179)
[[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AC8H0BQRDJ%3A1792070558.468179/?project=4510944073809921)

<!-- junior-session-footer:end -->

Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
Co-authored-by: Sergiy Dybskiy <sergiy.dybskiy@sentry.io>

This branch was successfully deployed

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