reviewing-api-reference

Reviews published API references against an 11-condition usability and contract-consistency bar, emitting an approve or revise verdict.

1|1|Updated May 24, 2026
One-click install
npx skills add https://github.com/bm629/agent-skills --skill reviewing-api-reference-bm629
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reviewing-api-reference
Source: https://github.com/bm629/agent-skills/tree/main/skills/reviewing-api-reference
Command: npx skills add https://github.com/bm629/agent-skills --skill reviewing-api-reference-bm629

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Published API references often drift from the engineering API spec, omit error responses, or leave developers unable to make a first authenticated call. This Skill acts as an independent acceptance gate that judges whether an integrating developer can actually integrate from the reference, catching drift, fabricated endpoints, and happy-path-only documentation before the docs ship. ## Core Features & Use Cases - 11-condition review bar: Judges first-call reachability, full operation/event coverage, first-class errors (RFC 9457), rate limits, pagination, versioning/deprecation, runnable samples, and grounding. - Contract-consistency spot-check: Traces every documented endpoint, field, error, and event against the handed-in api-spec, flagging drift or fabricated endpoints as the highest-impact defect. - Machine-parseable verdict: Emits exactly VERDICT: approve or VERDICT: revise plus actionable findings naming the failed condition, location, and fix. - Delta-scoped amendment reviews: On a change request, reviews only the changed blocks re-synced to the updated contract rather than re-reviewing the whole catalog. - Use Case: After authoring a REST API reference from an OpenAPI spec, run this gate before publishing; it returns a revise verdict if a documented endpoint is not declared in the spec or if list endpoints lack pagination conventions. ## Quick Start Use reviewing-api-reference to judge docs/api-reference.md against the handed-in api-spec and give me the verdict with actionable findings.

Frequently Asked Questions about reviewing-api-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review an API reference before publishing it?

Hand the finished API reference plus the upstream api-spec to this gate. It reads the reference as a first-time integrating developer, runs an 11-condition usability and contract-consistency checklist, and emits VERDICT: approve or VERDICT: revise with actionable findings.

What does an API documentation review checklist cover?

The bar covers first-call reachability with auth failure cases, full operation and webhook coverage, first-class errors using RFC 9457 Problem Details, rate limits and idempotency, pagination conventions, versioning and deprecation, runnable schema-matching samples, and consistency with the api-spec.

Can I review an API reference without the OpenAPI spec?

Yes, but the consistency check cannot fully run. The review flags the missing api-spec as an explicit assumption and judges the remaining usability conditions on the reference alone rather than silently approving.

When should I use reviewing-api-spec instead of this review?

Use reviewing-api-spec to gate the engineering wire contract itself, and this skill to judge the published consumer-facing reference derived from that contract. They are distinct artifacts with distinct bars.

Why does a thin API reference get approved without pagination or SDK sections?

The bar is proportional: pagination, rate limits, webhooks, and deprecation conditions are not applicable when the API lacks those surfaces. A small reference that satisfies every applicable condition passes, since brevity is correct sizing, not a gap.