Document Api Endpoint

What it does

The source focuses on drf-spectacular annotations, canonical response types and the distinction between absent and nullable fields. It also describes migrating legacy path definitions and handling endpoint-publication metadata. Its strongest theme is preventing generated documentation from drifting away from the actual response.

Best for

Contributors to Sentry’s API or closely related Django codebases using the same documentation and ownership conventions.

Tradeoffs and requirements

Repository paths, ownership enums and publication controls are highly specific. Promoting an endpoint can be a consequential access decision and needs owner authorization. A live response can also contain private data, so examples and tokens require careful handling.

Unknown; inspect source requirements and supporting scripts.

Install from the source

Inspect the pinned source snapshot and its supporting files first. The command selects this skill through the open-source skills CLI. Node.js and agent-specific setup may be required. Installation can download code; this catalog never runs it.

npx skills add https://github.com/getsentry/skills/tree/d12f250460ffd961f549dbebf7eeb0cf4afd4c2e/skills/document-api-endpoint --skill document-api-endpoint

Review pinned skill folder ↗ · CLI documentation ↗

After source review, use npx skills check and npx skills update to inspect and apply upstream updates. Re-check changed instructions before running them.

Safety & review signals

Static review only. This is not a security audit or a guarantee of safety.

SKILL.md text only; scripts, dependencies and runtime behavior not audited.

• Network Access — review the source context.
• Shell Or Package Install — review the source context.

Allowed tools declaration: Unknown. Runtime permissions and network behavior: Unknown.

AI Craft Pad Skill Score

86/100 · Metadata coverage 100% · Model 1.0

Scores summarize observable discovery signals. Popularity and repository activity apply to the whole repository. Unknown runtime safety earns no certification.

Documentation

100/100

100

Maintenance

100/100

100

License Clarity

100/100

100

Repository Health

100/100

100

Compatibility Evidence

80/100

80

Popularity

55/100

55

Originality

80/100

80

Static Safety

60/100

60

Suggested workflow

Find the serving endpoint class, compare representative sanitized responses with existing types, then update the canonical annotations and any legacy definition together. Keep publication changes explicit and separate from incidental documentation edits.

How to judge the result

Generate and validate the specification, exercise representative responses and inspect downstream compatibility. Confirm required versus optional fields and ensure that unrelated HTTP methods or endpoint visibility did not change accidentally.