Skip to content

Bump API schema to cb84288a - #20179

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

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

Copy link
Copy Markdown
Contributor

The change rebuilds API reference pages from a newer schema pin.
The plan checks API page loads, API 404s, and site error rate.
An issue escalates when API 404s rise or API page loads fall while other pages hold.

Monitoring in production

Services: sentry-docs, develop-docs.

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

Plan

What changed

The production build fetches OpenAPI JSON at SHA cb84288aa9947087cb5b4b22de3a3240fff96689.
It generates static /api/ category and endpoint pages from that file.
The pin range on getsentry/sentry-api-schema did not change openapi-derefed.json.
Page copy is expected to hold.
sentry-docs must deploy before the new pin is live.
develop-docs also ships this shared src/ file.
develop-docs does not render generated API pages.

Risk

A bad schema fetch can fail the whole sentry-docs build.
A valid schema with renamed slugs drops old /api/ pages.
Users then hit 404s on former reference URLs.
Shared src/ also deploys to develop-docs.
A compile fault there could error that site as well.

Intended effect

Generated API pages keep loading after the pin ships.
docs.page.load with page_type:api should hold its share of all page loads.
Absent: that share falls while total docs.page.load holds.
The OpenAPI JSON likely did not change, so the expected shift is hold, not a rise.
On a develop-docs ship this axis stays unknown.

Signal Baseline Rule Source
API page load share 4.6% (871 of 18837 docs.page.load) in 2026-10-21T16:00Z to 2026-10-22T16:00Z. Prior 23h API loads were 742 in 2026-10-20T17:00Z to 2026-10-21T16:00Z Hold near 4.6% of all docs.page.load. Absent if the share falls below 3% while total loads hold Sentry metrics, org sentry, project docs, production. Query metric.name:docs.page.load AND sentry.environment:production, group by page_type. Total query omits the group

Regression watch

A dropped or renamed endpoint shows up as /api/ 404s, not as a silent load hold.
A failed shared bundle can raise errors on the rest of the docs site too.
Client errors are not sliced to /api/ URLs. Watch site error rate with API 404s.
Algolia and kapa fetch failures already appear in production and are not this pin.

Signal Baseline Rule Source
API 404 share 2.2% (19 docs.page.not_found vs 871 API loads) in 2026-10-21T16:00Z to 2026-10-22T16:00Z. Prior 23h was 1.8% (13 vs 742) in 2026-10-20T17:00Z to 2026-10-21T16:00Z Hold in 1.8-2.2% of API page loads. Detected if the share rises above 2.2% at similar API volume Sentry metrics, org sentry, project docs, production. Query metric.name:docs.page.not_found AND sentry.environment:production AND requested_path:api*
Site error rate 1.1% (206 errors vs 18837 docs.page.load) in 2026-10-21T16:00Z to 2026-10-22T16:00Z Hold near 1.1% of page loads. Detected if the rate rises above 2% while page loads hold Sentry errors, org sentry, project docs. Query environment:production. Divide count() by total docs.page.load in the same window
develop-docs errors 33 error events in 2026-10-21T16:00Z to 2026-10-22T16:00Z Hold near 33 events per 24h only if traffic holds. Treat a jump without volume as unknown Sentry errors, org sentry, project develop-docs. Query environment:production

Not observable

Field-level OpenAPI copy at the new SHA. GitHub compare listed only CHANGELOG.md and package.json.
Client errors on /api/ URLs. All production errors used transaction /:path*?, and request.url.path:/api/* returned 0.
p75 LCP for /api/ pageloads. That query returned null.
Prior-day p95 for /api/ pageload and navigation spans.
Pre-ship request volume for develop-docs, so that error row has no rate.

@cursor

cursor Bot commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages kept their share of loads.

This branch was successfully deployed

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