Skip to content

Bump API schema to 2adfc005 - #20087

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

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

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 4:38pm UTC
sentry-docs Ready Ready Preview Oct 19, 2026 4:38pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit bce878c into master Oct 19, 2026
13 of 15 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-2adfc005 branch October 19, 2026 16:30
@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 that the rebuilt API reference shows the new tags field. It also watches API page loads, API not-found counts, and client errors on API URLs. An issue escalates when the tags field is missing, when API pages 404, or when those errors rise.

Services: sentry-docs.

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

Plan

What changed

Public API reference pages now build from OpenAPI schema 2adfc005. The events-dropped docs page documents a required tags string array on outcomes objects.

The change is live after sentry-docs deploys this pull request. The Vercel project and catalog path for the public docs site match that id. develop-docs rebuilds from the same repository but does not call apiCategories and does not serve OpenAPI pages.

Risk

A bad schema can fail the production docs build. It can also drop or break every API reference page. A smaller miss leaves the events-dropped page without tags or with a broken response schema. Client render errors can then appear on API URLs.

Intended effect

The live events-dropped page must document the new tags field. Absent means that page still omits tags after the deploy, or the page returns 404.

Signal Baseline Rule Source
tags field on the events-dropped API docs page Absent. Production HTML fetched at 2026-10-19T16:31:39Z lists query fields dataset, end, environment, project, start, statsPeriod, interval, outcome, and reason. It does not list tags. Confirmed when the page documents a required tags string array. Absent when tags is still missing or the page 404s. GET https://docs.sentry.io/api/explore/query-dropped-and-accepted-events-stats-by-outcome-and-reason/ and search the response schema for tags

Page loads alone do not confirm this content change. Low explore traffic can stay quiet after a good deploy.

Regression watch

A failed schema rebuild can 404 every API page. Watch 404s, client errors, and API page volume. The events-dropped page sits under explore, so also split that slice.

Signal Baseline Rule Source
API not-found share and explore 404s requested_path:api* was 12 events in 2026-10-18T16:31:39Z to 2026-10-19T16:31:39Z and 6 events in the prior 24h. That is about 1.5-1.8% next to 404-650 API page loads. requested_path:api/explore was 0. Top 24h paths were api/alerts 6, api/projects 2, api/detectors 2, api/org 1, api/events 1. Hold the api* 24h count in 6-12 and the share near 1.5-1.8%. Hold api/explore at 0. Escalate if api* 404s rise above 20 in 24h, if the share rises above 3%, or if api/explore is not 0. Sentry org sentry, project docs. Metric docs.page.not_found. Query environment:production requested_path:api*
Client errors on API URLs 282 events in 2026-10-17T16:31:39Z to 2026-10-19T16:31:39Z. API page loads in that 48h window were about 1052. A later 24h query used a different URL match and is not comparable. Hold. A 24h count with the same query should stay well below the 48h total. Escalate if that 24h count exceeds 200 while API page loads hold or fall. Sentry org sentry, project docs. Query environment:production AND url:"/api/"
API page loads 648 loads in 2026-10-18T16:31:39Z to 2026-10-19T16:31:39Z. About 404 loads in the prior 24h hourly buckets. Hourly values were 0-77 except 243 at 2026-10-18T12:00:00Z. Explore loads were 16 in the latest 24h and 7 in the prior 24h. Hold 24h API loads in 400-650. Hold explore loads in 7-16. Escalate if 24h API loads fall below 200 or explore loads stay at 0. Explore volume is low and may be inconclusive. Sentry org sentry, project docs. Metric docs.page.load. Query page_type:api environment:production. Explore slice adds api_category:explore
p95 API pageload and navigation duration 4428ms with 537 spans in 2026-10-18T16:31:39Z to 2026-10-19T16:31:39Z. 4658ms with 890 spans over the 48h window. Explore p95 was 2104ms with 7 spans in the latest 24h and 13 spans over 48h. Traces are sampled at 30% for users. Hold p95 in 4400-4700ms. Escalate if p95 rises above 6000ms or span count collapses while page loads continue. Sentry org sentry, project docs. Query span.op:[pageload,navigation] environment:production (url.full:/api/ OR http.target:/api/). Explore slice uses url.full:/api/explore/

If 404s rise, inspect whether generateStaticParams still emitted API paths. If client errors rise, inspect ApiPage render failures on those URLs.

Not observable

The schema diff copies the tags object four times. This plan could not prove a second public endpoint besides events-dropped. The live markdown export for that page had an empty response schema, so the HTML page is the source for tags. This session did not measure a matching 24h split for url:"/api/" errors. A transaction:/api/ trace query returned 0. Use url.full instead. develop-docs has no OpenAPI pages, so schema content is not observable there. A build-time schema fetch failure appears as a failed Vercel deploy, not as a Sentry metric.

This branch was successfully deployed

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