@sentry/api 0.419.0 → 0.420.0

package/README.md

@@ -83,6 +83,25 @@ const dataset: ListOrganizationTraceItemAttributesQueryDataset = "spans";
 const types: ListOrganizationTraceItemAttributesQueryAttributeType[] = ["string", "number"];
 ```
 
+### Query defaults
+
+A few operations send a query parameter by default to skip expensive work most callers don't need. The operation's documentation states the default.
+
+| Operation | Default | Effect |
+| --- | --- | --- |
+| `getOrganizationIssueEvent` | `collapse: ["adjacentEvents"]` | Skips the next/previous event lookups; `nextEventID` and `previousEventID` are `null` |
+
+The default applies only when the parameter is omitted or `undefined`. Any value you pass replaces it, and an empty list sends nothing:
+
+```ts
+const path = { organization_id_or_slug: "my-org", issue_id: "123", event_id: "latest" } as const;
+
+await sentry.getOrganizationIssueEvent({ path }); // ?collapse=adjacentEvents
+await sentry.getOrganizationIssueEvent({ path, query: { collapse: [] } }); // includes nextEventID/previousEventID
+```
+
+Standalone operations, bound methods, and `narrowError_*` wrappers behave the same way. The operation catalog describes the API itself, so it does not list these defaults.
+
 ### Operation discovery
 
 `@sentry/api/operations` exports a readonly catalog for offline discovery, without importing the client, validators, or transport:

package/dist/index.js

@@ -2477,7 +2477,8 @@ var listOrganizationIssueEvents = (options) => (options.client ?? client).get({
 var getOrganizationIssueEvent = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/{event_id}/",
-  ...options
+  ...options,
+  query: { ...options?.query, collapse: options?.query?.["collapse"] ?? ["adjacentEvents"] }
 });
 var listOrganizationIssueExternalIssues = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],

package/dist/sdk.gen.d.ts

@@ -2210,6 +2210,8 @@ export declare const listOrganizationIssueEvents: <ThrowOnError extends boolean
  * Retrieve an Issue Event
  *
  * Retrieves the details of an issue event.
+ *
+ * By default, the SDK sends `collapse: ["adjacentEvents"]`, which skips looking up the neighboring events (`nextEventID` and `previousEventID` are `null`). Passing the parameter replaces the default; `collapse: []` sends none.
  */
 export declare const getOrganizationIssueEvent: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationIssueEventData, ThrowOnError>) => import("./client").RequestResult<GetOrganizationIssueEventResponses, GetOrganizationIssueEventErrors, ThrowOnError, "fields">;
 /**

package/dist/sentry-client.gen.d.ts

@@ -2206,6 +2206,8 @@ export declare function createSentryClient(config?: Config): {
      * Retrieve an Issue Event
      *
      * Retrieves the details of an issue event.
+     *
+     * By default, the SDK sends `collapse: ["adjacentEvents"]`, which skips looking up the neighboring events (`nextEventID` and `previousEventID` are `null`). Passing the parameter replaces the default; `collapse: []` sends none.
      */
     readonly getOrganizationIssueEvent: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.GetOrganizationIssueEventData, ThrowOnError>>, "client">) => import("./client").RequestResult<types.GetOrganizationIssueEventResponses, types.GetOrganizationIssueEventErrors, ThrowOnError, "fields">;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/api",
-  "version": "0.419.0",
+  "version": "0.420.0",
   "description": "Official auto-generated TypeScript client for the Sentry public REST API",
   "keywords": [
     "sentry",