Skip to content

feat(experimental-docs): experimental parameter tag - #19979

Merged
wmak merged 2 commits into
masterfrom
wmak/feat/experimental-parameter-tag
Oct 14, 2026
Merged

wmak merged 2 commits into
masterfrom
wmak/feat/experimental-parameter-tag

Conversation

@wmak

@wmak wmak commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Parameters marked with x-sentry-experimental now get the same Experimental badge as experimental endpoints, without repeating the description notice.

Preview

image

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

wmak and others added 2 commits October 14, 2026 14:56
Parameters marked with x-sentry-experimental now get the same Experimental badge as experimental endpoints, without repeating the description notice.

Co-authored-by: Cursor <cursoragent@cursor.com>
The parameter badge does not repeat the warning, so the OpenAPI notice stays in the description.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel

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

Request Review

@wmak wmak changed the title Wmak/feat/experimental parameter tag feat(experimental-docs): experimental parameter tag Oct 14, 2026
@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 14, 2026
@cursor

cursor Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

API endpoint pages now show an Experimental badge on marked parameters. The plan checks API page loads, TypeErrors on those pages, and pageload time. An issue escalates when TypeErrors rise or API page loads fall.

Rollout complete

Services: sentry-docs.

Plan

What changed

Path, query, and body parameters with x-sentry-experimental now show an Experimental badge. The badge matches the existing endpoint badge. Parameter descriptions keep the experimental notice text. sentry-docs must deploy before this change is live. OpenAPI endpoint pages render only on that site. The same source also builds develop-docs. That other site does not serve these OpenAPI pages.

Risk

A bad parameter object can crash the parameter list during page render. Readers then see a broken API endpoint page. A wrong schema cast can hide enum choices. A mapping failure at build time can fail the production deploy.

Intended effect

The badge is a visual change. No Sentry metric increments when the badge renders. The executor cannot confirm intended effect from telemetry. Absent means experimental parameters still have no badge. That check needs a live API page.

Regression watch

This change can break API endpoint page render. Watch TypeErrors, API page loads, and pageload time on those URLs.

Quiet error days from 2026-10-07 to 2026-10-14 were 0-15 per UTC day. 2026-10-11 had 281 errors of type Event. Do not treat a repeat of that Event spike as this change. Watch TypeErrors instead.

Signal Baseline Rule Source
TypeError share of API page loads 0.25% in both windows. 2 TypeErrors and 810 loads from 2026-10-13T19:07:54Z to 2026-10-14T19:07:54Z. 13 TypeErrors and 5147 loads from 2026-10-07T19:07:54Z to 2026-10-14T19:07:54Z. Hold 0.20-0.30%. Escalate if the share rises above 0.50%. Sentry org sentry project docs. TypeErrors use error.type:TypeError environment:production http.url:docs.sentry.io/api/. Loads use docs.page.load with page_type:api environment:production.
API page loads 810 loads from 2026-10-13T19:07:54Z to 2026-10-14T19:07:54Z. 5147 loads from 2026-10-07T19:07:54Z to 2026-10-14T19:07:54Z. Mean 735 loads per day. Hold 735-810 loads per 24h. Escalate if 24h loads fall below 650. Sentry org sentry project docs. Metric docs.page.load. Query page_type:api environment:production.
API pageload time p95 7437ms from 347 pageloads from 2026-10-13T19:07:54Z to 2026-10-14T19:07:54Z. 8498ms from 2203 pageloads from 2026-10-07T19:07:54Z to 2026-10-14T19:07:54Z. Hold 7400-8500ms. Escalate if p95 rises above 10000ms. Sentry org sentry project docs. Query environment:production span.op:pageload http.url:docs.sentry.io/api/.
API navigation time p95 2045ms from 403 navigations from 2026-10-13T19:07:54Z to 2026-10-14T19:07:54Z. The seven day value was not measured. Hold 1800-2300ms in a 24h window. Escalate if p95 rises above 3000ms. Sentry org sentry project docs. Query environment:production span.op:navigation http.url:docs.sentry.io/api/.

If TypeError share rises, inspect the parameter list on API endpoint pages.

Not observable

Sentry cannot show whether the Experimental badge appears on experimental parameters. Sentry cannot show whether parameter descriptions still include the experimental notice. The docs.page.not_found query for api paths timed out. Navigation p95 over seven days is not measured.

@wmak
wmak merged commit 1bdea76 into master Oct 14, 2026
31 checks passed
@wmak
wmak deleted the wmak/feat/experimental-parameter-tag branch October 14, 2026 19:16

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 8c3b6394 Deployed Oct 14, 2026 by vercel[bot]
Preview – develop-docs — 8c3b6394 Deployed Oct 14, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants