gh-onezerocompany-claude-project-basics/skills/spec-author/templates/api-contract.md

API Contract Specification

Document ID: api-[feature]-[id]-[name] Status: Owner: Last Updated:

Overview

Purpose:

Base URL:

API Version:

Stability:

Authentication

Method:

Implementation:

Token Acquisition:

Scopes/Permissions:

Rate Limiting

Limits:

Headers:

Exceeded Limit Response:

Endpoints

GET /<!-- TODO: endpoint path -->

Query Parameters:

Response:

GET /<!-- TODO: endpoint path with parameter -->

Path Parameters:

Response:

POST /<!-- TODO: endpoint path -->

Request Body:

Response:

PUT /<!-- TODO: endpoint path -->
PATCH /<!-- TODO: endpoint path -->

Request Body:

Response:

DELETE /<!-- TODO: endpoint path -->

Response:

Data Models

Constraints:

Error Handling

Error Response Format:

Standard Error Codes:

Pagination

Webhooks