Repository navigation
feat(experimental-docs): experimental parameter tag - #19979
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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. Services: PlanWhat changedPath, 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. RiskA 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 effectThe 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 watchThis 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.
If TypeError share rises, inspect the parameter list on API endpoint pages. Not observableSentry 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. |
Parameters marked with x-sentry-experimental now get the same Experimental badge as experimental endpoints, without repeating the description notice.
Preview
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-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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