@sentry/api 0.115.0 → 0.116.0

package/README.md

@@ -1,12 +1,11 @@
-# Sentry API Schema
+# @sentry/api
 
-Sentry's public API schema and auto-generated TypeScript client, published as [`@sentry/api`](https://www.npmjs.com/package/@sentry/api).
+The official, auto-generated TypeScript client for Sentry's public REST API.
 
-## About
+[![npm](https://img.shields.io/npm/v/@sentry/api.svg)](https://www.npmjs.com/package/@sentry/api)
+[![license](https://img.shields.io/npm/l/@sentry/api.svg)](./LICENSE.md)
 
-This repository contains Sentry's [OpenAPI](https://swagger.io/specification/) v3.0.1 schema and tooling to generate TypeScript client from it. The schema source of truth lives in [getsentry/sentry](https://github.com/getsentry/sentry/tree/master/api-docs) and is synced here automatically.
-
-## Installation
+## Install
 
 ```bash
 npm install @sentry/api
@@ -14,22 +13,46 @@ npm install @sentry/api
 
 ## Usage
 
-```typescript
-import type { ... } from "@sentry/api";
+Pass `baseUrl` and an auth header to each call:
+
+```ts
+import { listYourOrganizations } from "@sentry/api";
+
+const { data, error } = await listYourOrganizations({
+  baseUrl: "https://sentry.io",
+  headers: { Authorization: `Bearer ${process.env.SENTRY_AUTH_TOKEN}` },
+});
+
+if (error) throw error;
+console.log(data);
 ```
 
-## Development
+Auth tokens and base URLs (including self-hosted and region URLs) are documented at https://docs.sentry.io/api/auth/.
 
-This project uses [Bun](https://bun.sh) as its package manager and build tool.
+## Pagination
 
-```bash
-# Install dependencies
-bun install
+Sentry uses cursor-based pagination via `Link` headers. Use `paginateAll` to collect all pages:
 
-# Build the package (generates types from OpenAPI schema, bundles, and emits declarations)
-bun run build
+```ts
+import { paginateAll, listAnOrganization_sProjects } from "@sentry/api";
+
+const projects = await paginateAll(
+  (cursor) => listAnOrganization_sProjects({
+    baseUrl: "https://sentry.io",
+    headers: { Authorization: `Bearer ${process.env.SENTRY_AUTH_TOKEN}` },
+    path: { organization_id_or_slug: "my-org" },
+    query: { cursor },
+  }),
+  "listAnOrganization_sProjects",
+);
 ```
 
+`unwrapPaginatedResult` and `parseSentryLinkHeader` are also exported for manual pagination.
+
+## Schema source
+
+The OpenAPI schema is synced from [`getsentry/sentry`](https://github.com/getsentry/sentry/tree/master/api-docs). Schema fixes belong there; build/tooling changes belong here.
+
 ## License
 
-FSL-1.1-Apache-2.0. See [LICENSE.md](LICENSE.md) for details.
+FSL-1.1-Apache-2.0. See [LICENSE.md](LICENSE.md).

package/dist/types.gen.d.ts

@@ -20699,7 +20699,12 @@ export type ResolveAShortIdData = {
          */
         issue_id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Fields to remove from the response to improve query performance.
+         */
+        collapse?: Array<'base' | 'filtered' | 'lifetime' | 'stats' | 'unhandled'>;
+    };
     url: '/api/0/organizations/{organization_id_or_slug}/shortids/{issue_id}/';
 };
 export type ResolveAShortIdErrors = {
@@ -30739,7 +30744,12 @@ export type RetrieveAnIssueData = {
          */
         issue_id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Fields to remove from the response to improve query performance.
+         */
+        collapse?: Array<'stats' | 'lifetime' | 'base' | 'unhandled' | 'filtered'>;
+    };
     url: '/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/';
 };
 export type RetrieveAnIssueErrors = {

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "@sentry/api",
-  "version": "0.115.0",
-  "description": "Auto-generated TypeScript client for the Sentry API",
+  "version": "0.116.0",
+  "description": "Official auto-generated TypeScript client for the Sentry public REST API",
+  "keywords": [
+    "sentry",
+    "sentry-api",
+    "openapi",
+    "typescript",
+    "api-client"
+  ],
   "license": "FSL-1.1-Apache-2.0",
   "type": "module",
   "module": "dist/index.js",