Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | 10x | /**
* sentry schema
*
* Browse and search the Sentry API schema. Shows available resources,
* operations, and endpoint details from the generated API index.
*
* Usage:
* sentry schema → list all resources
* sentry schema --all → flat list of all endpoints
* 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 monitor* → glob search for resources
*/
import type { SentryContext } from "../context.js";
import {
type ApiEndpoint,
getAllEndpoints,
getEndpoint,
getEndpointsByResource,
getResourceSummaries,
type ResourceSummary,
searchEndpoints,
} from "../lib/api-schema.js";
import { buildCommand } from "../lib/command.js";
import { OutputError } from "../lib/errors.js";
import { bold, cyan, muted, yellow } from "../lib/formatters/colors.js";
import { filterFields } from "../lib/formatters/json.js";
import {
colorTag,
mdKvTable,
renderMarkdown,
} from "../lib/formatters/markdown.js";
import { CommandOutput } from "../lib/formatters/output.js";
// ---------------------------------------------------------------------------
// Output data types
// ---------------------------------------------------------------------------
/** Discriminated union of all possible schema command outputs */
type SchemaResult =
| { kind: "resources"; resources: ResourceSummary[] }
| { kind: "endpoints"; endpoints: readonly ApiEndpoint[] }
| { kind: "endpoint"; endpoint: ApiEndpoint };
// ---------------------------------------------------------------------------
// Human formatters
// ---------------------------------------------------------------------------
/** Format a method string with appropriate coloring */
function formatMethod(method: string): string {
switch (method) {
case "GET":
return cyan(method);
case "POST":
return bold(method);
case "PUT":
return yellow(method);
case "DELETE":
return bold(method);
default:
return method;
}
}
/** Format the resource summary table (default view) */
function formatResourceList(resources: ResourceSummary[]): string {
if (resources.length === 0) {
return muted("No resources found.");
}
const maxName = Math.max(...resources.map((r) => r.name.length));
const maxCount = Math.max(
...resources.map((r) => String(r.endpointCount).length)
);
const padding = 4;
const header = `${bold("RESOURCE".padEnd(maxName + padding))}${bold("COUNT".padEnd(maxCount + padding))}${bold("METHODS")}`;
const rows = resources.map((r) => {
const name = cyan(r.name.padEnd(maxName + padding));
const count = String(r.endpointCount).padEnd(maxCount + padding);
const methods = muted(r.methods.join(", "));
return `${name}${count}${methods}`;
});
return [header, ...rows].join("\n");
}
/** Format a flat list of endpoints */
function formatEndpointList(endpoints: readonly ApiEndpoint[]): string {
if (endpoints.length === 0) {
return muted("No endpoints found.");
}
const maxMethod = Math.max(...endpoints.map((e) => e.method.length));
const padding = 2;
return endpoints
.map((e) => {
const colored = formatMethod(e.method);
const padded = `${colored}${" ".repeat(maxMethod + padding - e.method.length)}`;
const path = e.path;
const label = muted(e.operationId || e.fn);
const deprecated = e.deprecated ? yellow(" [deprecated]") : "";
return `${padded}${path} ${label}${deprecated}`;
})
.join("\n");
}
/** Format a single endpoint in detail using mdKvTable + renderMarkdown */
function formatEndpointDetail(endpoint: ApiEndpoint): string {
const kvRows: [string, string][] = [
["Resource", endpoint.resource],
["Operation", endpoint.operationId],
...(endpoint.fn
? [["Function", `\`${endpoint.fn}\``] as [string, string]]
: []),
];
if (endpoint.deprecated) {
kvRows.push(["Status", colorTag("yellow", "deprecated")]);
}
if (endpoint.pathParams.length > 0) {
kvRows.push(["Path Params", endpoint.pathParams.join(", ")]);
}
if (endpoint.queryParams.length > 0) {
kvRows.push(["Query Params", endpoint.queryParams.join(", ")]);
}
const heading = `## ${endpoint.method} \`${endpoint.path}\``;
const parts = [heading, "", mdKvTable(kvRows)];
if (endpoint.description) {
parts.push("", endpoint.description);
}
return renderMarkdown(parts.join("\n"));
}
/** Human renderer for all schema result variants */
function formatSchemaHuman(data: SchemaResult): string {
switch (data.kind) {
case "resources":
return formatResourceList(data.resources);
case "endpoints":
return formatEndpointList(data.endpoints);
case "endpoint":
return formatEndpointDetail(data.endpoint);
default:
return "";
}
}
// ---------------------------------------------------------------------------
// JSON transform — strip the internal `kind` discriminant
// ---------------------------------------------------------------------------
/**
* Transform schema output for JSON serialization.
* Strips the internal `kind` discriminant and applies `--fields` filtering.
*/
function jsonTransformSchema(data: SchemaResult, fields?: string[]): unknown {
let result: unknown;
switch (data.kind) {
case "resources":
result = data.resources;
break;
case "endpoints":
result = data.endpoints;
break;
case "endpoint":
result = data.endpoint;
break;
default:
result = data;
}
if (fields && fields.length > 0) {
return filterFields(result, fields);
}
return result;
}
// ---------------------------------------------------------------------------
// Query resolution
// ---------------------------------------------------------------------------
/**
* Resolve a resource + optional operation into a SchemaResult.
* Throws OutputError with fallback data for not-found cases.
*/
function resolveResourceQuery(
resource: string,
operation?: string
): SchemaResult {
// Glob-style search: if the resource arg contains * or ?, match resources
if (resource.includes("*") || resource.includes("?")) {
// Convert glob pattern to regex: * → .*, ? → ., escape other special chars
const escaped = resource
.toLowerCase()
.replace(/[.+^${}()|[\]\\]/g, "\\$&")
.replace(/\*/g, ".*")
.replace(/\?/g, ".");
const pattern = new RegExp(`^${escaped}$`);
const allResources = getResourceSummaries();
const matched = allResources.filter((r) =>
pattern.test(r.name.toLowerCase())
);
if (matched.length === 0) {
throw new OutputError({
kind: "resources",
resources: allResources,
} satisfies SchemaResult);
}
const endpoints = matched.flatMap((r) => getEndpointsByResource(r.name));
return { kind: "endpoints", endpoints };
}
// Resource + operation: show single endpoint detail
if (operation) {
const endpoint = getEndpoint(resource, operation);
if (endpoint) {
return { kind: "endpoint", endpoint };
}
// Show endpoints for this resource if it exists, otherwise show all resources
const resourceEndpoints = getEndpointsByResource(resource);
if (resourceEndpoints.length > 0) {
throw new OutputError({
kind: "endpoints",
endpoints: resourceEndpoints,
} satisfies SchemaResult);
}
throw new OutputError({
kind: "resources",
resources: getResourceSummaries(),
} satisfies SchemaResult);
}
// Resource only: show all endpoints for that resource
const endpoints = getEndpointsByResource(resource);
if (endpoints.length === 0) {
throw new OutputError({
kind: "resources",
resources: getResourceSummaries(),
} satisfies SchemaResult);
}
return { kind: "endpoints", endpoints };
}
// ---------------------------------------------------------------------------
// Command definition
// ---------------------------------------------------------------------------
type SchemaFlags = {
readonly all: boolean;
readonly search?: string;
};
export const schemaCommand = buildCommand({
auth: false,
docs: {
brief: "Browse the Sentry API schema",
fullDescription:
"Browse and search the Sentry API schema. Shows available resources, " +
"operations, and endpoint details. Use with --json for machine-readable output.\n\n" +
"Examples:\n" +
" sentry schema List all API resources\n" +
" sentry schema issues Show endpoints for a resource\n" +
" sentry schema issues list Show details for one endpoint\n" +
" sentry schema --all Flat list of all endpoints\n" +
" sentry schema --search monitor Search endpoints by keyword",
},
output: {
human: formatSchemaHuman,
jsonTransform: jsonTransformSchema,
},
parameters: {
flags: {
all: {
kind: "boolean",
brief: "Show all endpoints in a flat list",
default: false,
},
search: {
kind: "parsed",
parse: String,
brief: "Search endpoints by keyword",
optional: true,
},
},
aliases: { q: "search" },
positional: {
kind: "array",
parameter: {
brief: "Resource name and optional operation",
parse: String,
placeholder: "resource",
},
},
},
// biome-ignore lint/suspicious/useAwait: Stricli requires AsyncGenerator but schema queries are synchronous (in-memory JSON)
async *func(this: SentryContext, flags: SchemaFlags, ...args: string[]) {
const [resource, operation] = args;
// --search takes priority
if (flags.search) {
const results = searchEndpoints(flags.search);
if (results.length === 0) {
throw new OutputError({
kind: "endpoints",
endpoints: [],
} satisfies SchemaResult);
}
return yield new CommandOutput<SchemaResult>({
kind: "endpoints",
endpoints: results,
});
}
// --all: flat endpoint list
if (flags.all) {
return yield new CommandOutput<SchemaResult>({
kind: "endpoints",
endpoints: getAllEndpoints(),
});
}
// No positional args: show resource summary
if (!resource) {
const resources = getResourceSummaries();
return yield new CommandOutput<SchemaResult>({
kind: "resources",
resources,
});
}
// Resolve resource (with optional operation or glob pattern)
return yield new CommandOutput(resolveResourceQuery(resource, operation));
},
});
|