Skip to content

Bump API schema to 039965a8 - #19823

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 66592d9 into master Oct 6, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-039965a8 branch October 6, 2026 10:24
@vercel

vercel Bot commented Oct 6, 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 6, 2026 10:24am UTC
sentry-docs Building Building Preview Oct 6, 2026 10:24am UTC

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 6, 2026
@github-actions

github-actions Bot commented Oct 6, 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 6, 2026 •

Copy link
Copy Markdown
Contributor

The change adds a new layout type to generated symbol-source API pages. The plan checks API page loads, API not-found counts, and client errors. An issue escalates when API pages stop loading or client errors rise.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

Project symbol-source API pages now list nxsymstore as a layout type.
The sentry-docs and develop-docs services must deploy this commit.
Only sentry-docs serves those API pages from the OpenAPI schema.
The new copy is live on the build that pins schema SHA 039965a8.

Risk

A bad schema can fail static generation for the API reference tree.
Readers then receive 404 responses for former API URLs.
New markdown in the layout description can fail MDX on symbol-source pages.
The same src module also ships in develop-docs.
A load failure there would break that site even though it has no API pages.

Intended effect

Telemetry cannot read the new nxsymstore text on those pages.
API page loads after deploy show that the rebuilt API docs still serve.
Absent means those loads fall toward zero while other page types keep loading.

Signal Baseline Rule Source
API page loads 7-86 events per hour. 974 events in 24h. Share of all page loads is 5.0%. Hold inside the hourly band after deploy transients. Absent if daytime hours stay near 0 while other page types still load. Sentry org sentry, project docs, environment production. Query metric.name:docs.page.load AND page_type:api AND environment:production. Window 2026-10-05T10:25:04Z to 2026-10-06T10:25:04Z. Incomplete 10:00 UTC hour was 11.

Regression watch

This diff can 404 API URLs or throw client errors on API pages.
A broken shared src module can also raise errors on develop-docs.

Signal Baseline Rule Source
API not-found 10 events in 24h. Rate is 1.0% of API page loads. Paths were api/openapi.json, api/alerts, api/teams, and api/organizations. No symbol-source path. Hold near 0-10 events per 24h. Detected if the count rises above that band or a symbol-source path appears. Sentry org sentry, project docs, environment production. Query metric.name:docs.page.not_found AND environment:production AND requested_path:api*. Window 2026-10-05T10:25:04Z to 2026-10-06T10:25:04Z.
docs client errors 0-18 events per hour in most hours. 221 events in 24h. Rate is 1.13% of all page loads. One hour spiked to 73 at 2026-10-05T23:00Z. Hold in 0-18 per hour. Do not treat one short spike like 23:00 as this change. Detected if several hours stay above 18. Sentry org sentry, project docs, environment production. Query environment:production on the errors dataset. Window 2026-10-05T10:25:04Z to 2026-10-06T10:25:04Z. Top titles were promise rejection, location is not defined, and Algolia fetch failures.
develop-docs client errors 0-5 events per hour. 32 events in 24h. Hold in 0-5 per hour. Detected if several hours stay above 5. Sentry org sentry, project develop-docs, environment production. Query environment:production on the errors dataset. Window 2026-10-05T10:25:04Z to 2026-10-06T10:25:04Z.

Not observable

The nxsymstore string on the rendered symbol-source pages is not in Sentry.
Per-page HTML content is not queryable.

@cursor

cursor Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • API pages load on the new build and error counts stayed normal.

This branch was successfully deployed

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