Skip to content

Bump API schema to ceaace46 - #20139

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit b7fb950 into master Oct 21, 2026
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-ceaace46 branch October 21, 2026 14:35
@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.

@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 2:50pm UTC
sentry-docs Ready Ready Preview Oct 21, 2026 2:50pm UTC

Request Review

@cursor

cursor Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

The change points the API docs build at a new schema pin with no new endpoint pages. The plan checks API page loads, API 404s, and client errors on those pages. An issue escalates when 404s or errors rise.

Services: sentry-docs.

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

Plan

What changed

The docs build fetches the public OpenAPI file from GitHub commit ceaace4649140960038449cab61dcae33ec154b3. That file matches the prior pin 8de28f6d9e7b4b3817a6a40dd8f8a8ade069985e. Generated /api category and endpoint pages stay the same. sentry-docs must deploy before this pin is live. The Vercel production project sentry-docs builds those pages. The Sentry project tag is docs.

Risk

A broken pin can omit generated API pages from the static export. Those URLs then return 404. The API page client can throw if the schema shape is invalid. Reach is the /api category and endpoint pages. The OpenAPI body matches the last pin, so that risk is low.

Intended effect

The OpenAPI document did not change. No new endpoint page should appear. Production telemetry does not record the schema pin. The executor cannot confirm intended effect from a metric. Report intended effect as unknown.

Regression watch

This pin can drop or break generated API pages. Watch load share, 404s, and client errors on that path. If 404s rise, inspect apiCategories slugs in the static paths. If errors rise, inspect client exceptions on /api pages.

Signal Baseline Rule Source
API page load share 4.3-5.1% of all docs.page.load. Last 24h 745 of 17216 (4.3%). Prior 24h 856 of 16938 (5.1%). Hold in band. Sentry metrics, org sentry, project docs. sum(value, docs.page.load) with page_type:api environment:production over all docs.page.load with environment:production. Windows 2026-10-20T14:45:29Z to 2026-10-21T14:45:29Z and 2026-10-19T14:45:29Z to 2026-10-20T14:45:29Z.
API 404s 0.9-2.0 docs.page.not_found per 100 API page loads. Last 24h 15 404s with 745 API loads (2.0). Prior 24h about 8 404s with 856 API loads (0.9). The 48h 404 total is the top 10 requested_path groups only and sums to 23. Do not rise above 2.0 per 100 API page loads. Sentry metrics, org sentry, project docs. sum(value, docs.page.not_found) with requested_path:api* environment:production, paired with API docs.page.load above. Same windows.
Client errors on /api 1.1-1.7 error events per 100 API page loads. Last 24h 13 errors with 745 API loads (1.7). Prior 24h 9 errors with 856 API loads (1.1). This query can include /api/source-map and /api/aws-lambda-layers. Do not rise above 1.7 per 100 API page loads. Sentry errors, org sentry, project docs. environment:production (http.url:*/api/* OR transaction:*/api/*). Same windows.

Not observable

The schema pin SHA is not a production metric. Field-level API page copy is not in telemetry. The 48h API 404 total may be higher than the top 10 paths. pageload p95 on /api/* in the prior 24h was not measured with the prefix query.

This branch was successfully deployed

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