Skip to content

Bump API schema to f3f06b3a - #20145

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 39f102d into master Oct 21, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-f3f06b3a branch October 21, 2026 17:10
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 21, 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 21, 2026 •

Copy link
Copy Markdown
Contributor

The change rebuilds public API reference pages from a newer schema pin. The schema document matches the prior pin. An issue escalates when API page loads fall or API 404s and client errors rise.

Services: sentry-docs.

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

Plan

What changed

The build now fetches OpenAPI from commit f3f06b3a01c75e64f3939a23337cd82421dae305. Requests to /api/ category and endpoint pages still render from that pin. The schema JSON matches the prior pin e8dba7a51eb02705ffc062baf3f581856f6c684e. Only changelog and package version differ. This change is live after sentry-docs deploys. develop-docs also builds this commit but does not generate API pages.

Risk

A missing schema file fails the production build. A schema shape change can omit pages or throw during render. Users then hit 404s on former /api/ URLs. The API page client can throw TypeError on those URLs. Other docs paths do not read this schema.

Intended effect

The pin does not add new endpoint copy. Success is that API pages still load at the measured share. Absent looks like page_type api loads near zero while other page types hold.

Signal Baseline Window Source Rule
docs.page.load with page_type:api 782 loads in 4.6% of 16978 site loads. Earlier day 798 loads in 4.8% of 16799 site loads. Band 4.6-4.8% 2026-10-20T17:11:53Z to 2026-10-21T17:11:53Z and 2026-10-19T17:11:53Z to 2026-10-20T17:11:53Z Sentry metrics sentry/docs environment:production sum(value, docs.page.load, counter, none) grouped by page_type Hold in the 4.6-4.8% band. Treat as absent if api loads fall near zero while other page_type rows hold.

These two weekdays may not bound weekend traffic.

Regression watch

A bad catalog can 404 old endpoint URLs. It can also throw in the API page client. Compare each signal to API page load volume.

Signal Baseline Window Source Rule
docs.page.not_found with requested_path:api* 13 in 1.7% of 782 API loads. Earlier day 8 in 1.0% of 798 API loads. Band 1.0-1.7% 2026-10-20T17:11:53Z to 2026-10-21T17:11:53Z and 2026-10-19T17:11:53Z to 2026-10-20T17:11:53Z Sentry metrics sentry/docs environment:production requested_path:api* sum(value, docs.page.not_found, counter, none) Detected if the share rises above 1.7% of docs.page.load page_type:api.
Production errors on http.url:*/api/* 15 in 1.9% of 782 API loads. Earlier day 8 in 1.0% of 798 API loads. Band 1.0-1.9% 2026-10-20T17:11:53Z to 2026-10-21T17:11:53Z and 2026-10-19T17:11:53Z to 2026-10-20T17:11:53Z Sentry errors sentry/docs environment:production http.url:*/api/* count() Detected if the share rises above 1.9% of docs.page.load page_type:api.

If 404s rise, inspect requested_path for renamed endpoint slugs. If errors rise, inspect TypeError events on those URLs.

Not observable

Pageload duration for /api/ URLs did not return. The catch-all transaction /:path*? mixes all pages. There is no metric for schema field text on a page.

This branch was successfully deployed

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