api-docs

name	api-docs
description	Use when documenting endpoints or a public interface — task-oriented, with real examples.

API documentation

Use when documenting endpoints or a public interface — task-oriented, with real examples.

Checklist

• Document the task first, the endpoint second.
• Give a complete runnable request and its real response for each operation.
• Specify every parameter: type, required, default, and constraints.
• List the errors a caller must handle, with the exact codes.
• Cover auth, rate limits, and pagination once, up front.
• Generate from the source where you can so the docs cannot drift.