# sentry-api-schema

**Repository Path**: mirrors_getsentry/sentry-api-schema

## Basic Information

- **Project Name**: sentry-api-schema
- **Description**: Sentry's public API schema
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sentry API Schema

Sentry's public API schema and auto-generated TypeScript client, published as [`@sentry/api`](https://www.npmjs.com/package/@sentry/api).

## About

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

```bash
npm install @sentry/api
```

## Usage

```typescript
import type { ... } from "@sentry/api";
```

## Development

This project uses [Bun](https://bun.sh) as its package manager and build tool.

```bash
# Install dependencies
bun install

# Build the package (generates types from OpenAPI schema, bundles, and emits declarations)
bun run build
```

## License

FSL-1.1-Apache-2.0. See [LICENSE.md](LICENSE.md) for details.