Skip to content

Bump API schema to 42958f35 - #20277

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 27, 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 27, 2026 9:51pm UTC
sentry-docs Ready Ready Preview Oct 27, 2026 9:51pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 2ef8482 into master Oct 27, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-42958f35 branch October 27, 2026 21:44
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 27, 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 27, 2026 •

Copy link
Copy Markdown
Contributor

API documentation pages should keep loading after this schema pin. The plan checks API page loads, API 404s, and server 5xx responses. An issue escalates when API page loads fall or API 404s rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

Build now fetches the OpenAPI schema at git commit 42958f353ec9cd48951c98610ec163a870e6b084. The JSON blob matches the prior pin 9f048abeb531ed4bfa183fca51d9357f5854e035. API endpoint pages should keep the same paths and the same content.

sentry-docs must deploy before those pages are live. develop-docs also rebuilds shared src. OpenAPI pages render only on sentry-docs.

Risk

A bad schema can drop endpoint pages or break page render. Users then see 404s or client errors on API docs. The same src rebuild ships to develop-docs. That site does not render OpenAPI pages. If GitHub fetch fails, the production build fails and this change does not go live.

Intended effect

API docs pages keep loading. The schema blob did not change, so volume should hold. absent looks like API page loads falling while API 404s rise.

Signal Baseline Rule Source
docs.page.load with page_type:api in production 801 events in 2026-10-26T21:45:30Z–2026-10-27T21:45:30Z. Complete weekday UTC days in the prior week were 740, 804, 824, and 1061. Hold in the weekday band 740-1060 per 24h. Weekend days in that week were 188 and 526. Sentry org sentry project docs. Query: page_type:api environment:production on metric docs.page.load.

Regression watch

This pin rebuilds every API docs URL. A dropped path shows as 404s. A broken render shows as client errors or server 5xx.

Signal Baseline Rule Source
API 404 share: docs.page.not_found with requested_path:api* versus docs.page.load with page_type:api 10 not-found and 801 loads in 2026-10-26T21:45:30Z–2026-10-27T21:45:30Z. Share 1.2%. Seven-day weekday shares were about 0.7-2.3%. Hold in 0.7-2.4% on weekdays. Regression if the share rises above 4% while loads still hold. Sentry org sentry project docs. Not-found query: requested_path:api* environment:production on metric docs.page.not_found.
Production errors with http.url:*docs.sentry.io/api* 3 events in 2026-10-26T21:45:30Z–2026-10-27T21:45:30Z against 801 API page loads. Share 0.4%. Hold near 0.4% of API page loads. Regression if the 24h share rises above 2% while loads still hold. Sentry org sentry project docs. Query: environment:production http.url:*docs.sentry.io/api*.
http.server 5xx in production 0 events in 2026-10-26T21:45:30Z–2026-10-27T21:45:30Z. Same window had 7351 http.server spans. Hold at 0. Sentry org sentry project docs. Query: span.op:http.server http.response_status_code:>=500 http.response_status_code:<600 environment:production.

If API 404s rise, inspect requested_path on docs.page.not_found. Pre-ship 24h already showed api/alerts and api/prevent.

Not observable

develop-docs has no OpenAPI-generated pages. Intended effect cannot be confirmed on that ship. Server 5xx is site-wide, not sliced to /api/ paths.

This branch was successfully deployed

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