Skip to content

Bump API schema to 0a3f51ed - #19810

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit f3351ff into master Oct 5, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-0a3f51ed branch October 5, 2026 14:51
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 5, 2026
@github-actions

github-actions Bot commented Oct 5, 2026

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 5, 2026 •

Copy link
Copy Markdown
Contributor

The change points API reference pages at a new schema commit. Those pages still render the same OpenAPI document. The plan checks API page loads, client errors, and not-found counts. An issue escalates when API page loads fall or client errors rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

The build now fetches the OpenAPI schema from commit 0a3f51ed. The OpenAPI document at that commit matches the prior commit. Public API pages keep the same paths and fields. sentry-docs must deploy before those pages rebuild. develop-docs also rebuilds because this file lives in shared source.

Risk

A broken schema would fail static generation of API pages. A live deploy means the fetch and parse already succeeded. A remaining risk is a client render failure on those pages. Shared source also ships to develop-docs. That site does not serve these API pages.

Intended effect

This schema commit did not change the OpenAPI document the pages read. There is no new endpoint page or field to observe. Telemetry cannot confirm intended effect. Absent would be a new API page path with loads. That path does not exist in this change.

Regression watch

This diff could drop API pages or break their client render. Watch volume on those pages. Also watch errors and not-found counts on the same site.

Hourly API page loads spiked to 270 at 2026-10-04T11:00Z. Daily error counts spiked to 11,155 on 2026-10-04. Treat those spikes as prior noise. Do not use them as the hold band.

Signal Baseline Rule Source
API page loads 754 loads in 24h from 2026-10-04T14:52:47Z to 2026-10-05T14:52:47Z. Hourly values in that window were 7-98 aside from the 270 spike. Hold the 24h total in 400-900. A drop below 400 is a regression if other page types hold. Ignore one-hour spikes near 11:00 UTC. Sentry metrics, org sentry, project docs. Query: metric.name:docs.page.load AND metric.type:counter AND page_type:api AND environment:production
API path errors 6 events in the same 24h. Rate is 6 per 754 API page loads, or 0.8%. Titles were NotFoundError, Algolia fetch failures, and a truncated Error. Hold the rate under 1.5%. Escalate if the rate rises above 2% or new render errors appear. Sentry errors, org sentry, project docs. Query: environment:production AND (url:*/api/* OR transaction:*api*)
Page not found 125 counts in the same 24h. Hold the 24h count in 80-180. Escalate if the count rises above 250. Sentry metrics, org sentry, project docs. Query: metric.name:docs.page.not_found AND metric.type:counter AND environment:production
HTTP server failure rate 0.13% of 5440 sampled spans in the same 24h. p95 duration was 1.12s. Trace sample rate is 30%. Hold failure rate in 0.05-0.30%. Escalate if the rate rises above 0.5% or p95 rises above 2s. Sentry traces, org sentry, project docs. Query: environment:production AND span.op:http.server

If API path errors rise, inspect client stacks on ApiPage. Also inspect server logs for OpenAPI parse failures.

Not observable

Whether rendered API HTML matches commit 0a3f51ed is not in telemetry. The OpenAPI document did not change, so no content probe exists. Pageload traces do not name /api/ paths. They use the catch-all route. Pageload failure rate was 14% in this window and is too noisy to use.

This branch was successfully deployed

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