@sentry/api 0.410.0 → 0.412.0

package/README.md

@@ -83,6 +83,25 @@ const dataset: ListOrganizationTraceItemAttributesQueryDataset = "spans";
 const types: ListOrganizationTraceItemAttributesQueryAttributeType[] = ["string", "number"];
 ```
 
+### Operation discovery
+
+`@sentry/api/operations` exports a readonly catalog for offline discovery, without importing the client, validators, or transport:
+
+```ts
+import { operations } from "@sentry/api/operations";
+
+const logOperations = operations.filter(operation =>
+  operation.queryParameters.some(parameter =>
+    parameter.name === "dataset" && parameter.enum?.includes("logs"),
+  ),
+);
+console.log(logOperations.map(({ functionName, method, path }) => ({ functionName, method, path })));
+```
+
+Each `ApiOperation` records the actual exported `functionName`, original OpenAPI `operationId`, method, path, summary, description, tags, path parameter names, query metadata, and explicit deprecation flag. `ApiQueryParameter` includes the name, required flag, description, type, and declared enum values (item values for arrays). Operation parameters override inherited path parameters.
+
+The catalog is generated from the same schema and SDK output as each release. Consumers own search, grouping, ranking, and command aliases; the catalog does not fetch a live schema or infer undocumented API behavior.
+
 ### Browser sessions
 
 The browser helper configures session cookies and CSRF token injection:

package/dist/operation-types.d.ts

@@ -0,0 +1,36 @@
+/** Searchable query metadata from the release's OpenAPI specification. */
+export type ApiQueryParameter = {
+    /** Parameter name accepted by the operation. */
+    readonly name: string;
+    /** Whether the request must include this parameter. */
+    readonly required: boolean;
+    /** Usage description, when documented. */
+    readonly description?: string;
+    /** OpenAPI schema type, when declared. */
+    readonly type?: string;
+    /** Allowed scalar values, or allowed item values for an array parameter. */
+    readonly enum?: readonly (string | number | boolean | null)[];
+};
+/** An operation shipped by this SDK version, without consumer-specific policy. */
+export type ApiOperation = {
+    /** Actual exported SDK function name, after name normalization. */
+    readonly functionName: string;
+    /** Original OpenAPI identifier; an empty string means it was not declared. */
+    readonly operationId: string;
+    /** HTTP method used by the generated operation. */
+    readonly method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS" | "TRACE";
+    /** Canonical OpenAPI path including parameter placeholders. */
+    readonly path: string;
+    /** Short operation description, when documented. */
+    readonly summary?: string;
+    /** Detailed operation description; empty when undocumented. */
+    readonly description: string;
+    /** Categories assigned by the OpenAPI specification. */
+    readonly tags?: readonly string[];
+    /** Parameter names occurring in the path template. */
+    readonly pathParameters: readonly string[];
+    /** Query parameters after applying operation overrides to path-level parameters. */
+    readonly queryParameters: readonly ApiQueryParameter[];
+    /** Whether OpenAPI explicitly marks the operation deprecated. */
+    readonly deprecated: boolean;
+};

package/dist/operations.d.ts

@@ -0,0 +1,4 @@
+import type { ApiOperation } from './operation-types.ts';
+export type { ApiOperation, ApiQueryParameter } from './operation-types.ts';
+/** Offline metadata for the operations exported by this SDK version. */
+export declare const operations: readonly ApiOperation[];