API Specification
Owner: [Owner]
Status: [Draft/In review/Approved]
Version: [Version]
Target release: [Date or milestone]
Problem or decision: [Problem, decision, or outcome governed by this specification]
Reviewers: [Roles responsible for technical, product, security, and operational review]
1. Overview and version
[Method and path]
2. Authentication
[Auth scope and tenant context]
3. Resources and endpoints
[Parameter schema and validation]
4. Request schemas
[Success response and headers]
5. Response schemas
[Error code and retryability]
6. Errors
[Idempotency and versioning rule]
7. Pagination and filtering
[Pagination and filtering: record the behavior, data, constraints, edge cases, ownership, and acceptance evidence that apply to this API Specification]
8. Rate limits
[Rate limits: record the behavior, data, constraints, edge cases, ownership, and acceptance evidence that apply to this API Specification]
9. Compatibility and examples
[Compatibility and examples: record the behavior, data, constraints, edge cases, ownership, and acceptance evidence that apply to this API Specification]
Review and Change Control
[Reviewers, decision owner, unresolved questions, linked evidence, approval date, and change history]