Skip to content

Bump API schema to e3ee5395 - #20157

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

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

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 9:04pm UTC
sentry-docs Error Error Oct 21, 2026 9:04pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit b9d1913 into master Oct 21, 2026
10 of 12 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-e3ee5395 branch October 21, 2026 20: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 plan checks OpenAPI page loads, API-path 404s, and client errors on those pages. An issue escalates when OpenAPI page loads drop or those 404s or errors rise.

Services: sentry-docs.

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

Plan

What changed

The product-docs build fetches the public API schema from git SHA e3ee5395. The schema JSON matches the prior pin. Generated API docs pages stay the same after deploy. sentry-docs must deploy before this change is live. develop-docs rebuilds the same repository and does not render OpenAPI pages.

Risk

A missing schema file fails the product-docs build and blocks the ship. A schema that changes slugs returns 404 on old API docs URLs. Broken endpoint markup can throw in the browser. This pin has identical JSON, so those content failures are unlikely.

Intended effect

OpenAPI-generated API docs pages keep loading after the pin change. Absent looks like those loads fall toward zero while other docs pages still load.

Signal Baseline Window Rule Source
docs.page.load with page_type:api and has:api_category 16.6-17.4 per hour. 398 last 24h. 418 prior 24h. 2026-10-20T20:59:08Z to 2026-10-21T20:59:08Z and 2026-10-19T20:59:08Z to 2026-10-20T20:59:08Z Hold in the band. Sentry org sentry, project docs, environment production

Regression watch

This pin can still 404 API docs URLs if the static paths do not build. It can also throw in the API page client.

Signal Baseline Window Rule Source
docs.page.not_found with requested_path:api/* 2.5-3.6% of OpenAPI page loads. 10 last 24h. 15 prior 24h. 2026-10-20T20:59:08Z to 2026-10-21T20:59:08Z and 2026-10-19T20:59:08Z to 2026-10-20T20:59:08Z Hold in the band. Sentry org sentry, project docs, environment production
Error events with url:*docs.sentry.io/api* 0.9-1.8% of page_type:api loads. 14 last 24h. 7 prior 24h. 2026-10-20T20:59:08Z to 2026-10-21T20:59:08Z and 2026-10-19T20:59:08Z to 2026-10-20T20:59:08Z Hold in the band. Sentry org sentry, project docs, environment production

The error rate may include third-party script noise. Known titles include Algolia fetch failures and Event promise rejections. Escalate when new titles appear from API page render.

If API-path 404s rise, split by requested_path. A single category such as api/events can hide in the total.

Not observable

No signal compares page body text to schema fields. Traces sample at 30 percent, so pageload counts are not full traffic. The 24h pageload p95 query for docs.sentry.io/api did not return. Use 404s and errors for failure, not pageload time.

This branch had an error being deployed

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