Patterns

API Content Patterns

Model reference pages around endpoints, examples, parameters, and migration notes.

Endpoint framing

Start with the endpoint label, then describe intent in one sentence before diving into payload shape, edge cases, and examples.

Group parameters by path, query, and body. Readers should not need to infer where values belong.

Reserve a final section for retry logic, auth failures, and migration notes. This keeps the page useful when something goes wrong in production.