Skip to content

Bump API schema to 377fc3e1 - #19869

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 82007d6 into master Oct 8, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-377fc3e1 branch October 8, 2026 20:34
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026

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 8, 2026 •

Copy link
Copy Markdown
Contributor

The change adds two experimental API reference pages for starring a service span. The plan checks those page loads, other API page loads, and API not-found events. An issue escalates when API not-found events rise or API page loads fall.

Monitoring in production

Services: sentry-docs, develop-docs.

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

Plan

What changed

Generated API reference pages now include Star a Service Span and Unstar a Service Span under Explore. Those routes did not exist on the previous OpenAPI snapshot. The sentry-docs service must deploy this change before the new pages are live. The develop-docs service also deploys this commit because it shares the src tree. That site does not render generated API reference pages.

Risk

A broken schema can fail static generation for every API reference page. Users then hit not-found events on API routes. A render defect in the shared API page component can fail every endpoint page. The new experimental pages can fail alone if their markdown or parameters are invalid.

Intended effect

The new pages are live when docs.page.load records page_type:api with api_endpoint:star-a-service-span or api_endpoint:unstar-a-service-span. Those attributes were zero before deploy because the pages did not exist. absent means those counters stay at zero while other API page loads stay in band. Low traffic can leave both new counters at zero. Then mark intended effect unknown, not absent.

Signal Baseline Rule Source
docs.page.load with page_type:api and api_endpoint:star-a-service-span 0 events over 2026-10-07T20:35:00Z to 2026-10-08T20:35:00Z. The page did not exist. Rise above 0. Sentry org sentry, project docs, environment production. Query metric.name:docs.page.load AND page_type:api AND api_endpoint:star-a-service-span AND environment:production.
docs.page.load with page_type:api and api_endpoint:unstar-a-service-span 0 events over the same window. The page did not exist. Rise above 0. Same project. Query metric.name:docs.page.load AND page_type:api AND api_endpoint:unstar-a-service-span AND environment:production.

Regression watch

This schema rebuild can drop existing API reference pages if generation throws. It can also 404 Explore routes if slugify of the new names collides. Watch API not-found events and existing API page loads on the same path. Watch production error events. A new client exception from the API page component is in scope. Algolia insights fetch failures already occur and are not this change.

Signal Baseline Rule Source
docs.page.not_found with requested_path:api* 0-19 events/hour in complete 1h buckets from 2026-10-07T20:00:00Z to 2026-10-08T19:00:00Z. Most hours were 0-1. One hour reached 19 at 2026-10-08T01:00:00Z. 24h fraction was 30 not-found events against 943 API page loads, about 3.1%. Rise above 19 events/hour, or a sustained rise above the 3.1% fraction. Sentry org sentry, project docs, environment production. Query metric.name:docs.page.not_found AND requested_path:api* AND environment:production.
docs.page.load with page_type:api 4-92 events/hour in the same complete 1h buckets. Traffic is diurnal. Peak 92 at 2026-10-08T13:00:00Z. 24h total 943. Fall below 4 events/hour while other page types still load. Same project. Query metric.name:docs.page.load AND page_type:api AND environment:production.
Production error events 0-14 events/hour in the same complete 1h buckets, while API page loads were 4-92 events/hour. 24h total 103. Peak 14 at 2026-10-08T05:00:00Z. Leading titles were Algolia insights fetch failures. Rise above 14 events/hour. Treat a new API page TypeError as detected even inside the band. Sentry org sentry, project docs, environment production. Query environment:production on the errors dataset.

Not observable

Page HTML text for Star a Service Span is not in telemetry. Pageload latency for API docs URLs was not isolated. Catch-all transaction names mix those routes with other pages. The develop-docs site does not render generated API reference pages, so that ship cannot confirm intended effect. Hourly error events for develop-docs were not sampled.

@cursor

cursor Bot commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • Readers loaded both new star and unstar API pages.

This branch was successfully deployed

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