Skip to content

Bump API schema to 74806daa - #20018

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

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

Conversation

@sentry-api-schema-updater

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

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

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 8a682ff into master Oct 15, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-74806daa branch October 15, 2026 22:21
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 15, 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 15, 2026 •

Copy link
Copy Markdown
Contributor

The change updates two existing API reference pages. It adds one documented response field and new description text.
The plan checks API page loads, API page failure rate, and API 404s.
An issue escalates when the API page failure rate rises or those pages stop loading.

Services: sentry-docs.

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

Plan

What changed

Readers of two Integration Platform API pages now see new description text.
The sentry-app-components response now documents a required installationUuid field.
One page is List an Organization's Installed Sentry App Components.
The other is Create or Link an External Issue Through a Sentry App.
Those pages live under /api/integration/.
This change is live only after sentry-docs deploys.
Developer docs do not generate these pages and do not fetch the schema.
The pick is sentry-docs because only that site builds API pages from this schema pin.

Risk

A bad schema can drop generated API pages or break their render.
Readers then see 404 pages or client errors on /api/ paths.
The two edited pages and other generated API pages share the same generator.
The Integration Platform category is the closest slice.

Intended effect

The new description text and the installationUuid field do not emit a metric.
Telemetry cannot show that the new text appeared.
Treat intended_effect as unknown.
absent would mean a reader still sees the old description and no installationUuid field.

Regression watch

Traces sample at 30 percent. Treat span counts as sampled traffic, not full volume.
Third-party fetch errors from kapa and Algolia already appear on /api/ pages. Do not count those as this change.
If the failure rate rises, check client errors on /api/integration/ for render faults.

Signal Baseline Window Comparison Source
API page failure rate 1.0-1.4% 2026-10-14T22:21:57Z to 2026-10-15T22:21:57Z hold in this band Sentry project docs. Pageload and navigation spans. Query span.op:[pageload,navigation] sentry.environment:production url.path:*/api/*. Measured 1.19% on 843 sampled spans.
API page load rate 0.48-0.64 per min 2026-10-08T22:21:57Z to 2026-10-15T22:21:57Z hold in this band Sentry project docs. Metric docs.page.load with page_type:api and environment:production. Last 24h was 921. Last 7d was 5067.
Sampled API 404s 0 2026-10-14T22:21:57Z to 2026-10-15T22:21:57Z hold at 0 Sentry project docs. Pageload and navigation spans with http.response_status_code:404 and /api/ in the span description.
sentry-app page load share 0.3-0.8% of API page loads 2026-10-08T22:21:57Z to 2026-10-15T22:21:57Z hold in this band and stay above zero Sentry project docs. Metric docs.page.load with environment:production and api_endpoint or path matching *sentry-app* or *external-issue*. Last 24h was 3 of 921. Last 7d was 41 of 5067.

Not observable

The new page text and the installationUuid field have no queryable signal.
The docs.page.not_found metric timed out in Sentry.

This branch was successfully deployed

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