Skip to content

Bump API schema to 7b9f8d9b - #20221

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit bc06b25 into master Oct 23, 2026
14 of 15 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-7b9f8d9b branch October 23, 2026 22:57
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 23, 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 23, 2026 •

Copy link
Copy Markdown
Contributor

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

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

The docs build now pins the public API schema to SHA 7b9f8d9b. That schema commit changed only rpc_method_schema.json. The build fetches openapi-derefed.json, which did not change in this pin. API reference pages should keep the same paths and fields.

sentry-docs must deploy before the pin is live on API pages. develop-docs also deploys this src file. develop-docs does not render OpenAPI pages. Catalog and Vercel deploy config both ship src to these two services.

These signals live in Sentry project docs. They move when sentry-docs deploys.

Risk

A bad pin can fail the sentry-docs build or omit API routes. Users then see not-found pages on old API URLs. A malformed schema can throw while an API page renders. develop-docs does not fetch the schema at build. A SHA-only edit should not change develop-docs pages.

Intended effect

This pin does not add a new API page or field. The intended effect is that API pages still load after the rebuild.

Absent: API page loads drop while platforms page loads hold.

Signal Baseline Window Rule Source
docs.page.load, page_type:api, environment:production 834-835 counts in 24h. Hourly 9-74 in complete hours. Share versus platforms loads 835/8345 = 10.0% 2026-10-22T22:58:00Z to 2026-10-23T22:58:00Z Hold. Expected shift is none because openapi-derefed.json did not change. Absent if the 24h count falls while platforms loads hold Sentry metrics, org sentry, project docs

Regression watch

A slug change would 404 old API URLs. A render fault would raise client errors on those URLs. Platforms page loads show whether traffic dropped site-wide.

Signal Baseline Window Rule Source
docs.page.not_found, environment:production, requested_path api/alerts 6 counts. 6/835 = 0.7% of API page loads 2026-10-22T22:58:00Z to 2026-10-23T22:58:00Z Hold this share. A rise means alerts API slugs broke Sentry metrics, org sentry, project docs
docs.page.not_found, environment:production, requested_path api/events 4 counts. 4/835 = 0.5% of API page loads 2026-10-22T22:58:00Z to 2026-10-23T22:58:00Z Hold this share. A rise means events API slugs broke Sentry metrics, org sentry, project docs
docs.page.not_found, environment:production, requested_path api/projects 3 counts. 3/835 = 0.4% of API page loads 2026-10-22T22:58:00Z to 2026-10-23T22:58:00Z Hold this share. A rise means projects API slugs broke Sentry metrics, org sentry, project docs
error events, environment:production, http.url:/api/ 10 events. 10/835 = 1.2% of API page loads. Site-wide errors 310. Types: TypeError 7, Event 2, NS_ERROR_NOT_INITIALIZED 1 2026-10-22T22:58:00Z to 2026-10-23T22:58:00Z Hold this share of API page loads. A rise is a render fault on API pages Sentry errors, org sentry, project docs
docs.page.load, page_type:platforms, environment:production 8345 counts in 24h 2026-10-22T22:58:00Z to 2026-10-23T22:58:00Z Hold. If this falls with API loads, traffic dropped. If only API loads fall, this change broke API pages Sentry metrics, org sentry, project docs

Not observable

Live pages do not expose the schema SHA. rpc_method_schema.json is not read by this site. A traces query for API 4xx and 5xx timed out. The not-found metric listing returns only the top requested_path groups. Smaller api paths may be missing from that list. develop-docs has no OpenAPI page-load signal.

@cursor

cursor Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages kept loading after the ship, and not-found counts and API errors did not rise.
  • API pages kept loading after the ship, and not-found counts and API errors did not rise.

This branch was successfully deployed

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