Skip to content

Bump API schema to ca9a742d - #20215

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

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

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 10:02pm UTC
sentry-docs Ready Ready Preview Oct 23, 2026 10:02pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 9d363eb into master Oct 23, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-ca9a742d branch October 23, 2026 21:56
@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 build pins a newer API schema. The spec JSON at that pin is unchanged. API reference pages should keep loading. The plan checks API page loads, API 404s, and client TypeErrors. An issue escalates when API 404s rise or API page loads fall.

Rollout complete

Services: sentry-docs.

Plan

What changed

The site now builds API reference pages from schema SHA ca9a742d75cabaaa38cbf4ce634047290c7258fb.
The OpenAPI JSON at that SHA matches SHA 5c2854c5a13ddfae7210a254064538ed15717c0c.
The schema commit only adds TypeScript query enum types in sentry-api-schema.
Requests to /api/ pages should keep the same slugs, titles, and parameters.
sentry-docs must deploy before this pin is live.
develop-docs shares src/build/resolveOpenAPI.ts but does not generate these pages.

Risk

A missing or invalid schema JSON fails the production build.
Users then keep the previous deploy.
If operation names change, existing /api/ URLs return 404.
This pin does not change those names.
A schema the API page cannot render would throw in the client.

Intended effect

API pages should keep loading. The spec JSON did not change, so the load share should hold.
confirmed means the API share of docs.page.load stays in the band.
absent means that share falls toward zero while total page loads stay in band.

Signal Baseline Window Source Rule
API page-load share 4.70-5.24% of docs.page.load. Last 24h: 847 API loads of 16158 total. Prior 24h: 828 of 17614. 2026-10-21T21:56:44Z to 2026-10-22T21:56:44Z and 2026-10-22T21:56:44Z to 2026-10-23T21:56:44Z Sentry org sentry, project docs. Metric docs.page.load. Filter environment:production. Group page_type. API rows use page_type:api. Hold in band. The share may move with weekday traffic.

Regression watch

A bad pin would 404 old /api/ URLs or throw in the API page client.
API 404s are the sliced availability signal. TypeErrors are the client fault signal.
TypeErrors are site-wide. Errors could not be sliced to /api/ URLs.

Signal Baseline Window Source Rule
API 404 rate 1.18-1.21% of API page loads. 10 API 404s in each 24h window against 847 and 828 API loads. 2026-10-21T21:56:44Z to 2026-10-22T21:56:44Z and 2026-10-22T21:56:44Z to 2026-10-23T21:56:44Z Sentry org sentry, project docs. Metric docs.page.not_found. Filter requested_path:api* environment:production. Denominator is docs.page.load with page_type:api. Hold in band. Escalate if the rate rises above the band. If it rises, inspect /api/ 404 paths.
TypeError rate 0.28-0.38% of page loads. Last 24h: 45 TypeErrors of 16158 loads. Prior 24h: 66 of 17614. 2026-10-21T21:56:44Z to 2026-10-22T21:56:44Z and 2026-10-22T21:56:44Z to 2026-10-23T21:56:44Z Sentry org sentry, project docs. Errors with error.type:TypeError environment:production. Denominator is docs.page.load with environment:production. Hold in band. Escalate if the rate rises above the band.

Not observable

Rendered field text versus the old spec has no content metric. The JSON is unchanged.
Pageload traces for /api/ URLs returned 0 rows. A grouped follow-up timed out.
Client errors sliced by transaction:/api* returned 0. Transaction names do not match those paths.

This branch was successfully deployed

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