fix(cli): improve schema discovery by betegon · Pull Request #1658 · getsentry/toolkit

betegon · 2026-10-25T21:23:53Z

sentry schema now discovers API capabilities from OpenAPI metadata and real CLI command paths, including log, trace, and alert metrics. Ambiguous queries return candidates with context instead of silently choosing the first endpoint; exact lookups keep their JSON shape.

Reuses command introspection and schema generation, with tests for API/CLI growth and compatibility.

Examples:

# Finds Explore's dataset=logs as well as feature-flag audit logs
sentry schema logs

# Uses the CLI relationship and explains the dataset=logs selector
sentry schema log list

# Resolves the alias to trace list: dataset=spans, is_transaction:true
sentry schema trace ls

# Maps metric alert inspection to getOrganizationDetector
sentry schema alert metrics view

# Returns matching list operations instead of choosing the first one
sentry schema issues list

# Exact lookup still returns one endpoint object, without match metadata
sentry schema listOrganizationEvents --json

Validation: typecheck, lint, and schema tests pass. The full local suite is not green: an unchanged installer test fails on macOS, and asset-catalog tests require the unavailable actool.

vercel · 2026-10-25T21:23:58Z

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Actions	Updated
sentry-local	Skipped		Oct 26, 2026 8:15pm UTC

sentry-warden · 2026-10-26T15:43:36Z

+  const matches = searchEndpoints(query, undefined, references);
+  if (matches.length > 0) {
+    return { kind: "endpoints", endpoints: matches };
+  }


Method-prefixed exact IDs return an array instead of one endpoint object

sentry schema GET listOrganizationEvents (and similar METHOD + operationId/fn lookups) resolves as kind: "endpoints", so --json emits a one-element array instead of the bare endpoint object exact lookups are documented to keep.

Evidence

resolveIdentifierLookup(query) matches the raw string only, so GET listOrganizationEvents never hits the single-endpoint branch.

searchEndpoints() strips the method, exact-matches listOrganizationEvents, and returns a plain one-element list with no match metadata.

resolveResourceQuery() then always wraps any searchEndpoints() hit as { kind: "endpoints" }, including that single exact result.

Path and bare-identifier exact paths still return { kind: "endpoint" }; tests cover those shapes but not METHOD + operationId.

_{Identified by Warden · code-review · Y6V-GWQ}

Fix attempt detected (commit 4f38e78)

The resolver was rewritten to improve schema lookup and preserve exact endpoint results, but METHOD-prefixed operation IDs still fall through to searchEndpoints and are returned as a one-element endpoints array.

The original issue appears unresolved. Please review and try again.

_{Evaluated by Warden}

BYK

This is pretty great! Pushing back for even more automation to prevent drift.

BYK · 2026-10-26T20:37:08Z

I think all this should be part of the @sentry/api module.

BYK · 2026-10-26T20:39:16Z


 export const viewCommand = buildCommand({
  docs: {
+    relatedApi: [TRACE_DETAILS_API],


Instead of manually indicating these, we should be able to use the same mechanism we use to determine destructive commands with actual code inspection and generate this data on the fly at/before build time which would be easier to maintain.

BYK · 2026-10-26T20:39:49Z

 *   sentry schema --search <query>     → search endpoints by keyword
- *   sentry schema <resource>           → show endpoints for a resource
- *   sentry schema <resource> <op>      → show detailed endpoint info
+ *   sentry schema <concept>            → discover related API endpoints


We should move all these examples to the command's examples section.

BYK · 2026-10-26T20:40:33Z

+    !(operation || query.includes(" ")) &&
+    (resource.includes("*") || resource.includes("?"))
+  ) {
+    return resolveGlobQuery(resource);


We should use fuzzy-match and our shared search utility functions here too.

BYK · 2026-10-26T20:41:06Z

+const METRIC_DETECTOR_QUERY = `type:${METRIC_DETECTOR_TYPE}`;
+
+/** API references shared by metric alert commands; detectors also serve other products. */
+export const METRIC_ALERT_API = {


These also should come from @sentry/api? And definitely auto-generated.

BYK · 2026-10-26T20:41:53Z

-  if (startMatch) {
-    return startMatch;
+/** Conservative English plurals for discovery only, never endpoint identity. */
+function normalizeWord(word: string): string {


Again, see my fuzzy-match comment

betegon marked this pull request as ready for review October 25, 2026 21:26

github-actions Bot added the risk: medium PR risk score: medium label Oct 25, 2026

vercel Bot temporarily deployed to Preview October 25, 2026 21:41 Inactive

betegon force-pushed the fix/cli-schema-discovery branch from 74c333a to c500f15 Compare October 25, 2026 21:44

vercel Bot temporarily deployed to Preview October 25, 2026 21:44 Inactive

betegon force-pushed the fix/cli-schema-discovery branch from c500f15 to b1bb28d Compare October 26, 2026 15:20

vercel Bot temporarily deployed to Preview October 26, 2026 15:20 Inactive

sentry-warden Bot reviewed Oct 26, 2026

View reviewed changes

betegon added 2 commits October 26, 2026 21:15

fix(cli): improve schema discovery

3b29296

fix(cli): preserve command discovery with HTTP filters

4f38e78

betegon force-pushed the fix/cli-schema-discovery branch from b1bb28d to 4f38e78 Compare October 26, 2026 20:15

vercel Bot temporarily deployed to Preview October 26, 2026 20:15 Inactive

BYK requested changes Oct 26, 2026

View reviewed changes

Navigation Menu

Repository navigation

fix(cli): improve schema discovery - #1658

fix(cli): improve schema discovery#1658
betegon wants to merge 2 commits into
mainfrom
fix/cli-schema-discovery

betegon commented Oct 25, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Oct 25, 2026 •

edited

Loading

Uh oh!

sentry-warden Bot Oct 26, 2026

Uh oh!

sentry-warden Bot Oct 26, 2026

Uh oh!

BYK left a comment

Uh oh!

BYK Oct 26, 2026

Uh oh!

BYK Oct 26, 2026

Uh oh!

BYK Oct 26, 2026

Uh oh!

BYK Oct 26, 2026

Uh oh!

BYK Oct 26, 2026

Uh oh!

BYK Oct 26, 2026

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

betegon commented Oct 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel Bot commented Oct 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sentry-warden Bot Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

sentry-warden Bot Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

BYK Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

BYK Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

BYK Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

BYK Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

BYK Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

BYK Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

betegon commented Oct 25, 2026 •

edited

Loading

vercel Bot commented Oct 25, 2026 •

edited

Loading