Skip to content

Bump API schema to 527d8368 - #20096

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 99854f0 into master Oct 19, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-527d8368 branch October 19, 2026 17:23
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 19, 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 19, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks API page loads, API not-found counts, and client TypeErrors. A new Investigations category page should record loads after people open it. An issue escalates when API page loads fall or TypeErrors rise.

Services: sentry-docs.

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

Plan

What changed

Requests to the API docs now include an Investigations category page. The page path is /api/investigations/. sentry-docs must deploy before this page is live. The OpenAPI schema SHA is 527d83685db0907ac445b7d897428fb0727f55ab. This SHA adds an Investigations tag with a display description. The SHA adds no new endpoint paths.

Risk

A failed category build omits or 404s existing API pages. A client throw in the API category page shows as a TypeError on the docs catch-all route. The new category has no endpoints, so the page lists none.

Intended effect

The new Investigations category page must be reachable. Confirm it with docs.page.load for api_category:investigations. That counter is 0 before deploy. A value above 0 after deploy confirms the page loaded. If the counter stays at 0 and docs.page.not_found for requested_path:api/investigations stays at 0, record unknown. This path had no visitors before deploy. If investigations not-found rises above 0, record absent.

Signal Baseline Rule Source
docs.page.load api_category:investigations 0 counts per 24h, 2026-10-18T17:23:52Z to 2026-10-19T17:23:52Z rise above 0 Sentry org sentry project docs, sum(value, docs.page.load, counter, none) with api_category:investigations environment:production
docs.page.not_found requested_path:api/investigations 0 counts per 24h, same window hold at 0 Sentry org sentry project docs, sum(value, docs.page.not_found, counter, none) with requested_path:api/investigations environment:production

Regression watch

Existing API pages can 404 if category generation drops them. The events category is the busiest API slice. A throw in the shared docs page shows as a production TypeError.

Signal Baseline Rule Source
docs.page.load page_type:api 692 counts per 24h, 2026-10-18T17:23:52Z to 2026-10-19T17:23:52Z hold near this 24h volume. Treat a drop below half as a regression Sentry org sentry project docs, sum(value, docs.page.load, counter, none) with page_type:api environment:production
docs.page.load api_category:events 80 counts per 24h, same window hold near this 24h volume. Treat a drop below half as a regression Sentry org sentry project docs, sum(value, docs.page.load, counter, none) grouped by api_category with environment:production
docs.page.not_found requested_path:*api* 14 counts per 24h versus 692 API page loads, same window, about 2.0% of those attempts hold this not-found share. A rise in not-found while API loads fall is a regression Sentry org sentry project docs, sum(value, docs.page.not_found, counter, none) with requested_path:*api* sentry.environment:production
TypeError events 88 events per 24h, same window, of 194 production errors hold near this 24h volume. A rise with this deploy is a regression Sentry org sentry project docs, error events environment:production grouped by error.type

Not observable

No synthetic check confirms the Investigations heading text. Trace latency for /api/ pages did not return in this session. A 7-day API page-load band also did not return.

This branch was successfully deployed

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