API Concepts
The conventions every open REST API endpoint shares — resources, pagination, idempotency, and error semantics.
▸ BETA
▸ APPLIES TO
cheetah service >=0.0.132
Four short pages document the conventions every open REST API endpoint shares. Read them once and the API reference has no surprises left:
- Resource model — what the resources are, how they're identified, and how representations are shaped.
- Pagination — the limit/offset envelope, ordering guarantees, and how to walk pages without losing items.
- Idempotency — which operations are safe to repeat, and where deduplication is your side's job.
- Errors and retries — the error envelope, status codes, and which failures to retry.