Skip to content

Bump API schema to f56baf12 - #20118

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

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

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 1:05am UTC
sentry-docs Ready Ready Preview Oct 21, 2026 1:05am UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit c9cb8e7 into master Oct 21, 2026
16 of 18 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-f56baf12 branch October 21, 2026 00:58
@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 pull request pins a new schema SHA for API reference pages.
  • The OpenAPI document behind that pin did not change.
  • Watch API page 404s, API page loads, and client errors. An issue escalates when API 404s or error events rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

API reference pages now build from schema SHA f56baf126283e34ad030980cdfe86b4872667459.
The OpenAPI file at that SHA matches the prior SHA a25931d59d71c403d7d912bf9eca4308ab36f70b.
Public API page content should stay the same.
sentry-docs must deploy before the pin is live on API pages.
develop-docs also deploys the shared app from this commit.
API reference pages render only on sentry-docs.
The Sentry project tag for sentry-docs is docs.

Risk

A bad schema pin can drop API endpoint pages or fail the sentry-docs build.
Users who open old API URLs then see 404 pages.
The shared page module also ships on develop-docs.
A bad import can fail that ship.
develop-docs does not render OpenAPI pages.

Intended effect

The pin has no new queryable effect.
The OpenAPI document did not change.
Production does not emit the schema SHA.
The executor should leave intended_effect unknown.
API page loads that hold only show that pages still exist.
That hold is not proof of the pin.

Regression watch

Compare each rate to the band from the two 24h halves of 2026-10-19T00:59:47Z to 2026-10-21T00:59:47Z.
The recent half is 2026-10-20T00:59:47Z to 2026-10-21T00:59:47Z.
The prior half is 2026-10-19T00:59:47Z to 2026-10-20T00:59:47Z.
Algolia fetch failures already add to the docs error count. Do not treat an Algolia-only rise as this change.

Signal Baseline Window Rule Source
API page 404 rate 1.6-1.9% of API page loads. Recent 14 of 877. Prior 15 of 802. 2026-10-19T00:59:47Z to 2026-10-21T00:59:47Z Hold in the band. Escalate if the rate rises above the band. Sentry org sentry, project docs. Metric docs.page.not_found with requested_path:api* over docs.page.load with page_type:api. environment:production
API page load share 4.8-5.0% of all page loads. Recent 877 of 17649. Prior 802 of 16610. 2026-10-19T00:59:47Z to 2026-10-21T00:59:47Z Hold in the band. A fall below the band means API pages may be missing. Sentry org sentry, project docs. Metric docs.page.load. page_type:api over all page_type. environment:production
Docs error rate 0.73-1.34% of page loads. Recent 128 of 17649. Prior 223 of 16610. The rate may vary day to day. 2026-10-19T00:59:47Z to 2026-10-21T00:59:47Z Hold in the band. Escalate if the rate rises above the band. Sentry org sentry, project docs. Error events over docs.page.load. environment:production
develop-docs error rate 1.8-2.1% of page loads. Recent 31 of 1748. Prior 46 of 2165. 2026-10-19T00:59:47Z to 2026-10-21T00:59:47Z Hold in the band. Escalate if the rate rises above the band. Sentry org sentry, project develop-docs. Error events over docs.page.load. environment:production

If API 404s rise, check which requested_path values under api grew.

Not observable

Production does not emit the pinned schema SHA.
API page text correctness has no metric.
Error events are not tagged by API page, so an API-only error rise can hide.
Build-time fetch of the OpenAPI file is visible only as deploy success or failure.

inventarSarah pushed a commit that referenced this pull request Oct 21, 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 — 736fe315 Deployed Oct 21, 2026 by vercel[bot]
Preview – develop-docs — 736fe315 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