Skip to content

Bump API schema to 2b03abf7 - #20101

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

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

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 9:01am UTC
sentry-docs Ready Ready Preview Oct 20, 2026 9:01am UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit cc97b0c into master Oct 20, 2026
1 of 3 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-2b03abf7 branch October 20, 2026 08:54
@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 docs page loads, API docs 404s, and client TypeErrors on API docs pages. An issue escalates when those 404s rise or those TypeErrors rise.

Services: sentry-docs.

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

Plan

What changed

The docs build fetches openapi-derefed.json from git SHA 2b03abf7. That file matches the prior SHA c8e163b2. Generated API docs pages stay the same.

This change is live after sentry-docs deploys. develop-docs does not call apiCategories and does not ship this pin.

Risk

Risk is low because the OpenAPI document did not change. A failed fetch of the new SHA fails the Vercel build and blocks the deploy. A bad document that still parses could drop API pages or change slugs. That path is unlikely for this pin. If API pages fail to generate, users hit 404s on api paths. If ApiPage cannot render the schema, users see client TypeErrors.

Intended effect

This pin does not change generated API docs content. There is no new queryable user behavior. API page loads that hold do not prove the pin. The executor should record intended_effect as unknown.

Regression watch

If this pin is wrong, API docs pages fail to generate or fail to render. Watch API docs 404s and client TypeErrors on those pages. Pair each with API docs page load volume.

The 404 share may include guessed URLs such as api/gui. The TypeErrors may be third-party script noise on API pages. The last 24h TypeError count is higher than the day before.

Signal Query Baseline Rule Window Source
API docs page loads metric.name:docs.page.load AND page_type:api AND environment:production 601-815 counts per 24h hold in 601-815 per 24h 2026-10-18T08:55:07Z to 2026-10-20T08:55:07Z Sentry org sentry project docs
API docs 404 share metric.name:docs.page.not_found AND environment:production AND requested_path:*api* over API docs page loads 1.2-1.6% hold in 1.2-1.6% 2026-10-18T08:55:07Z to 2026-10-20T08:55:07Z Sentry org sentry project docs
API docs TypeError share environment:production AND url:"*/api/*" AND error.type:TypeError over API docs page loads 0.0-0.7% hold in 0.0-0.7% 2026-10-18T08:55:07Z to 2026-10-20T08:55:07Z Sentry org sentry project docs

Measured values: last 24h had 815 API docs page loads, 13 API 404s, and 6 TypeErrors. The prior 24h had 601 API docs page loads, 7 API 404s, and 0 TypeErrors.

Not observable

Generated API page text is not in telemetry. Span query span.op:[ui.pageload,ui.navigation] environment:production http.url:"*/api/*" returned 0 rows. The api_category metric attribute is not searchable.

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