@sentry/api 0.419.0 → 0.421.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -0
- package/dist/index.js +2 -1
- package/dist/sdk.gen.d.ts +2 -0
- package/dist/sentry-client.gen.d.ts +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -83,6 +83,25 @@ const dataset: ListOrganizationTraceItemAttributesQueryDataset = "spans";
|
|
|
83
83
|
const types: ListOrganizationTraceItemAttributesQueryAttributeType[] = ["string", "number"];
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
+
### Query defaults
|
|
87
|
+
|
|
88
|
+
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.
|
|
89
|
+
|
|
90
|
+
| Operation | Default | Effect |
|
|
91
|
+
| --- | --- | --- |
|
|
92
|
+
| `getOrganizationIssueEvent` | `collapse: ["adjacentEvents"]` | Skips the next/previous event lookups; `nextEventID` and `previousEventID` are `null` |
|
|
93
|
+
|
|
94
|
+
The default applies only when the parameter is omitted or `undefined`. Any value you pass replaces it, and an empty list sends nothing:
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
const path = { organization_id_or_slug: "my-org", issue_id: "123", event_id: "latest" } as const;
|
|
98
|
+
|
|
99
|
+
await sentry.getOrganizationIssueEvent({ path }); // ?collapse=adjacentEvents
|
|
100
|
+
await sentry.getOrganizationIssueEvent({ path, query: { collapse: [] } }); // includes nextEventID/previousEventID
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
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.
|
|
104
|
+
|
|
86
105
|
### Operation discovery
|
|
87
106
|
|
|
88
107
|
`@sentry/api/operations` exports a readonly catalog for offline discovery, without importing the client, validators, or transport:
|
package/dist/index.js
CHANGED
|
@@ -2477,7 +2477,8 @@ var listOrganizationIssueEvents = (options) => (options.client ?? client).get({
|
|
|
2477
2477
|
var getOrganizationIssueEvent = (options) => (options.client ?? client).get({
|
|
2478
2478
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2479
2479
|
url: "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/{event_id}/",
|
|
2480
|
-
...options
|
|
2480
|
+
...options,
|
|
2481
|
+
query: { ...options?.query, collapse: options?.query?.["collapse"] ?? ["adjacentEvents"] }
|
|
2481
2482
|
});
|
|
2482
2483
|
var listOrganizationIssueExternalIssues = (options) => (options.client ?? client).get({
|
|
2483
2484
|
security: [{ scheme: "bearer", type: "http" }],
|
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -2210,6 +2210,8 @@ export declare const listOrganizationIssueEvents: <ThrowOnError extends boolean
|
|
|
2210
2210
|
* Retrieve an Issue Event
|
|
2211
2211
|
*
|
|
2212
2212
|
* Retrieves the details of an issue event.
|
|
2213
|
+
*
|
|
2214
|
+
* 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.
|
|
2213
2215
|
*/
|
|
2214
2216
|
export declare const getOrganizationIssueEvent: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationIssueEventData, ThrowOnError>) => import("./client").RequestResult<GetOrganizationIssueEventResponses, GetOrganizationIssueEventErrors, ThrowOnError, "fields">;
|
|
2215
2217
|
/**
|
|
@@ -2206,6 +2206,8 @@ export declare function createSentryClient(config?: Config): {
|
|
|
2206
2206
|
* Retrieve an Issue Event
|
|
2207
2207
|
*
|
|
2208
2208
|
* Retrieves the details of an issue event.
|
|
2209
|
+
*
|
|
2210
|
+
* 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.
|
|
2209
2211
|
*/
|
|
2210
2212
|
readonly getOrganizationIssueEvent: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.GetOrganizationIssueEventData, ThrowOnError>>, "client">) => import("./client").RequestResult<types.GetOrganizationIssueEventResponses, types.GetOrganizationIssueEventErrors, ThrowOnError, "fields">;
|
|
2211
2213
|
/**
|