Skip to content

Bump API schema to c8e163b2 - #20100

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 20, 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 20, 2026 8:56am UTC
sentry-docs Ready Ready Preview Oct 20, 2026 8:56am UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 50999f2 into master Oct 20, 2026
7 of 9 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-c8e163b2 branch October 20, 2026 08:50
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 20, 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 20, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API-path 404s, API-path errors, and API page latency.
An issue escalates when API 404s or API-path errors rise.
An issue also escalates when API page loads fall as a share of all page loads.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The public API reference rebuilds from OpenAPI schema pin c8e163b2.
That pin does not change openapi-derefed.json.
Rendered API category and endpoint pages stay the same.
sentry-docs must deploy before the pin is live.
develop-docs also deploys because it shares this source tree.
develop-docs does not serve the OpenAPI API reference.

Risk

A bad schema can omit API pages and return 404s for known URLs.
Broken API pages can also raise client errors on the API path.
This pin only updates ownership stats, so content risk is low.
A schema fetch or parse failure fails the production build.

Intended effect

This pin adds no new API page and no new metric.
Success looks like API page loads holding their share of all page loads.
Absent looks like that share falling while all page loads hold.

Signal Baseline Band Rule Source
API page load share 4.9% of docs.page.load in 24h. 4.3% over 7d. Counts 825 of 16904 in 24h and 4849 of 113873 in 7d. 4.3-4.9% Hold in the band. Absent if the share falls below 4.3% while all page loads hold. Sentry org sentry, project docs, environment production. Metric docs.page.load. Share is page_type:api over all docs.page.load. Windows 2026-10-19T08:50:00Z to 2026-10-20T08:50:54Z and 2026-10-13T08:50:00Z to 2026-10-20T08:50:54Z.

Regression watch

A bad pin would 404 known API URLs or slow API page loads.
API 404s are the first user-visible failure on this path.

Signal Baseline Band Rule Source
API 404 rate 13 docs.page.not_found with requested_path api* in 24h, 1.6% of 825 API page loads. 57 in 7d, 1.2% of 4849. 1.2-1.6% of API page loads Hold in the band. Detected if the rate rises above 1.6%. Sentry org sentry, project docs, environment production. Metric docs.page.not_found query requested_path:api*. Denominator is docs.page.load with page_type:api. Windows 2026-10-19T08:50:00Z to 2026-10-20T08:50:54Z and 2026-10-13T08:50:00Z to 2026-10-20T08:50:54Z.
API-path errors 11 production errors with url or transaction matching /api/ in 24h, 1.3% of API page loads. 306 in 7d, 6.3% of API page loads. The 7d rate is higher than the last 24h. The 24h titles are mostly client widget failures. 1.3-6.3% of API page loads Hold in or below the band. Detected if the 24h rate rises above 6.3%. Sentry org sentry, project docs. Errors query environment:production AND (url:/api/ OR transaction:/api/). Windows 2026-10-19T08:50:00Z to 2026-10-20T08:50:54Z and 2026-10-13T08:50:00Z to 2026-10-20T08:50:54Z.
API page p95 latency pageload and navigation p95 4549ms in 24h and 5278ms in 7d on url.path /api/*. Traces are sampled at 30%. 4.5-5.3s Hold in the band. Detected if p95 rises above 5.3s. Sentry org sentry, project docs. Spans query span.op:[pageload,navigation] sentry.environment:production url.path:/api/*. Fields count() and p95(span.duration). Windows 2026-10-19T08:50:00Z to 2026-10-20T08:50:54Z and 2026-10-13T08:50:00Z to 2026-10-20T08:50:54Z.

Not observable

Whether the live build used schema SHA c8e163b204d82a42cb46e9f1c989e39608727b55.
Field-level API reference text. No content hash exists in telemetry.
develop-docs has no OpenAPI API pages, so this pin has no intended-effect signal there.
Schema fetch errors occur at build time and do not appear in production metrics.

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 — 6a6ce632 Deployed Oct 20, 2026 by vercel[bot]
Preview – develop-docs — 6a6ce632 Deployed Oct 20, 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