Skip to content

Bump API schema to fa042997 - #20188

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 03beb4f into master Oct 22, 2026
0 of 2 checks passed
@vercel

vercel Bot commented Oct 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Building Building Preview Oct 22, 2026 5:36pm UTC
sentry-docs Building Building Preview Oct 22, 2026 5:36pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-fa042997 branch October 22, 2026 17:36
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 22, 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 22, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API reference page loads, API not-found counts, and client errors on those pages.
An issue escalates when API page loads fall while other pages hold.
An issue also escalates when API not-found counts or API-page errors rise.

Services: sentry-docs, develop-docs.

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

Plan

What changed

API reference pages at /api/<category>/ and /api/<category>/<endpoint>/ now build from schema pin fa042997.
The OpenAPI file at this pin matches the previous pin 1f67a23b.
Category slugs and endpoint slugs stay the same.
sentry-docs must deploy before these pages are live.
develop-docs also deploys this commit because src/ is shared.
That site does not render these OpenAPI pages.

Risk

A bad schema pin can omit API pages or change slugs.
Readers then hit not-found pages on those URLs.
A parse failure during static generation fails the whole user-docs build.
This pin does not change the schema file, so slug churn is unlikely.
The developer docs site does not call this schema at render time.

Intended effect

The pin is live when API page loads hold. New endpoint pages are not expected.
absent looks like API page loads falling toward zero while site page loads hold.

Signal Baseline Rule Source
API page loads 866 loads in 2026-10-21T17:37:43Z to 2026-10-22T17:37:43Z. 740 loads on calendar 2026-10-21. Band 740-866 per 24h. Hold in 740-866 per 24h. Do not fall below 740 while site loads hold. Sentry org sentry, project docs. Metric docs.page.load. Query environment:production page_type:api. Aggregate sum(value, docs.page.load, counter, none).
API share of site loads 866 / 18664 = 4.6% in that 24h window. 740 / 18144 = 4.1% on calendar 2026-10-21. Band 4.1-4.6%. Hold in 4.1-4.6%. absent if the share falls well below 4.1% while site loads stay near 18144-18664. Same metric. Site denominator query environment:production with no page_type filter.

Regression watch

A missing or renamed endpoint shows up as not-found on /api/ paths.
A broken API page shows up as a client error on those URLs.

Signal Baseline Rule Source
API not-found on busiest paths api/alerts 9, api/events 4, api/organizations 3 in 2026-10-21T17:37:43Z to 2026-10-22T17:37:43Z. Combined 16 events. 16 / 866 API loads = 1.8%. Only this 24h window was measured. Hold near 1.8% of API page loads. Escalate if this share rises above 3%. If those counts rise, inspect logs for missing category or endpoint slugs. Sentry org sentry, project docs. Metric docs.page.not_found. Query environment:production. Group by requested_path. Paths api/alerts, api/events, api/organizations.
Client errors on API URLs 5 events in 2026-10-21T17:37:43Z to 2026-10-22T17:37:43Z. 5 / 866 API loads = 0.6%. Only this 24h window was measured. Hold near 0.6% of API page loads. Escalate if this rate rises above 1.5%. Sentry org sentry, project docs. Dataset errors. Query environment:production (http.url:*/api/* OR transaction:*/api/*). Aggregate count().
Site page loads 18664 loads in 2026-10-21T17:37:43Z to 2026-10-22T17:37:43Z. 18144 loads on calendar 2026-10-21. Band 18144-18664 per 24h. Hold in 18144-18664 per 24h. A drop with API loads points to a full user-docs build miss. Sentry org sentry, project docs. Metric docs.page.load. Query environment:production. Aggregate sum(value, docs.page.load, counter, none).

Not observable

Pageload traces for /api/ URLs did not match the catch-all route name.
A URL-filtered trace query timed out. LCP for these pages was not measured.
The full 7-day daily series for API page loads timed out on retry.
The band uses the rolling 24h window and the 2026-10-21 calendar day.
A total of every requested_path that starts with api over 24h was not summed.
Use the three measured not-found paths above.
The schema SHA is not emitted in runtime telemetry.

This branch was successfully deployed

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