Lightlines
By getsentry

document-api-endpoint

getsentry1.1k installs

Accurate API docs and response types for Sentry.

What it does

Creates accurate OpenAPI documentation and response types for Sentry API endpoints by matching their declared schemas to runtime behavior.

When to use it

Use when documenting an endpoint, correcting request or response types, migrating legacy API documentation, or making an endpoint public.

How to use it

Give it an endpoint documentation or typing task in a Sentry project; it updates the schema declarations and validates them against endpoint behavior.

What you provide

  • An existing project

Uses

Latest review

What you need · 5

Uses drf-spectacular to declare and generate the endpoint's OpenAPI documentation.

Uses pnpm to run the API example validation command.

Requires pytest in the project's .venv to run endpoint documentation tests with --reuse-db.


Access · 1

This skill

Sentry API

Read

Reads live Sentry endpoint responses