RESEARCH AND DOCUMENTATION / Sentry
Sentry API Endpoint Documentation
Aligns a Sentry API endpoint’s runtime response, TypedDict definitions and drf-spectacular OpenAPI schema.
“Document and type a Sentry API endpoint. Write or fix @extend_schema decorators, specify response TypedDicts, type request parameters, correct type drift between the declared”
01 / THE REASONING
Why this made the selection.
- Checks runtime serialization against types and schema, including the difference between an absent field and a nullable one.
- Calls out route-level replacement of legacy schema entries, so documenting one method does not silently lose sibling HTTP methods.
02 / THE REVIEW RECORD
What we actually inspected.
Source review has boundaries.
A clear record is more useful than a “safe” badge.
Material inspected
- skills/document-api-endpoint/SKILL.md
- README.md (installation, compatibility and licence sections)
- LICENSE
Our findings
- The complete definition was read, including canonical serializer types, request/response examples, schema validation and PUBLIC promotion steps.
- It requires tests and generated documentation checks, but this catalogue did not run the Sentry development environment.
Not established by this review
- No Sentry endpoint, schema build, example validator or authenticated API request was run.
The review applies to the material and revision named here. A newer upstream release can change its behavior.
03 / PUT IT TO WORK
Add a skill to your workflow.
DOCUMENTED COMMAND
npx skills add https://github.com/getsentry/skills/tree/c2f99a5b04b4cd992ec3022d7c2c3e23e938d241/skills/document-api-endpointCopying does not execute this command. It may retrieve a newer version than the reviewed source.
- Install the complete document-api-endpoint directory.
- Use it in a Sentry checkout and follow the linked public-API development guide before changing endpoint visibility.
- Choose the intended host and project scope in the installer. The source revision is pinned; the installer itself is not executed or version-pinned by this review.
Before you start
- Node.js/npm and git for the documented Skills installer
- A Sentry development checkout with its documented backend/frontend tooling
- Knowledge of the endpoint contract; a suitable API token only if a live request is explicitly needed
04 / FOLLOW THE EVIDENCE
The source trail.
Our notes are separate from the original resource.
Check upstream before adopting a new version.
https://github.com/getsentry/skills/blob/c2f99a5b04b4cd992ec3022d7c2c3e23e938d241/skills/document-api-endpoint/SKILL.md
Supports: summary, upstreamDescription, whySelected, bestFor, limitations, review, access
https://github.com/getsentry/skills/blob/c2f99a5b04b4cd992ec3022d7c2c3e23e938d241/README.md
Supports: install, compatibility, access, license
https://github.com/getsentry/skills/blob/c2f99a5b04b4cd992ec3022d7c2c3e23e938d241/LICENSE
Supports: license, access.cost
https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/README.md
Supports: install
https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/src/git.ts
Supports: install
https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/src/source-parser.ts
Supports: install
https://develop.sentry.dev/backend/api/public/
Supports: whySelected, limitations, install, access