Skip to content

Bump API schema to 2cb441c4 - #19840

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 91b70b3 into master Oct 7, 2026
3 of 5 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-2cb441c4 branch October 7, 2026 15:23
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 7, 2026
@github-actions

github-actions Bot commented Oct 7, 2026

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 7, 2026 •

Copy link
Copy Markdown
Contributor

The build now pins a new API schema SHA. API reference pages rebuild from that pin. An issue escalates when API page errors rise, 404s rise, or API page loads fall.

Monitoring in production

Services: sentry-docs.

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

Plan

What changed

The build fetches OpenAPI from SHA 2cb441c4511d32661687b8a566da647a3c1c0deb.
That schema builds static API pages at /api/{category} and /api/{category}/{endpoint}.
The SHA commit did not change openapi-derefed.json.
API page bodies should match the prior pin.
sentry-docs must deploy before this pin is live.

Risk

A bad schema can fail the Vercel build and block the ship.
A schema that changes slugs can 404 former API pages.
A schema that changes shape can throw during static render.
Users then see missing API pages or client errors on those pages.
Other docs sections do not read this schema.
A production deploy still replaces the whole site.

Intended effect

This pin has no queryable new runtime behavior.
The OpenAPI file the site fetches did not change in this SHA.
Telemetry cannot show the new SHA.
Do not treat steady API page loads as confirmed.
absent is not measurable unless API pages fail to generate after deploy.

Regression watch

If this pin is wrong, API reference pages break first.
Watch 404s, client errors, pageload failure rate, and API page load volume.
Traces are sampled at 30%.
The failure rate may be noisy on low volume hours.

Window: 2026-10-06T15:00:00Z to 2026-10-07T15:00:00Z. Use complete hours only.

Signal Baseline Rule Source
API page loads 14-72 per hour Hold in this band. Escalate when hours fall below 14. Sentry metric docs.page.load with page_type:api and environment:production on project docs
API 404s 0-3 per hour Rise above 3 per hour Sentry metric docs.page.not_found with requested_path:api* and environment:production on project docs
API page errors 0-3 per hour. 12 TypeError events against 806 API page loads, about 1.5% Rise above 3 per hour Sentry errors environment:production http.url:*/api/* on project docs
API pageload failure rate 0-0.13 most hours. One hour reached 0.30 Rise above 0.30, or stay above 0.13 for two hours Sentry traces span.op:[pageload,navigation] url.path:*/api/* environment:production on project docs

Not observable

The new SHA is not emitted as a metric or log field.
API page body text is not compared to the schema in telemetry.
The GitHub fetch of openapi-derefed.json runs at build time and has no production span.
Hourly p95 pageload duration was not sampled. The 24h p95 was 7120ms.

solnic pushed a commit that referenced this pull request Oct 8, 2026
Co-authored-by: sentry-api-schema-updater[bot] <271575301+sentry-api-schema-updater[bot]@users.noreply.github.com>

This branch was successfully deployed

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