# API Sprint OpenAPI Template

Use this short template before an API sprint starts.

## 1. Business Action

- Workflow:
- Owner:
- User:
- System A:
- System B:
- Success metric:

## 2. Endpoint Contract

- Method:
- Path:
- Purpose:
- Auth:
- Permissions:
- Rate limits:

## 3. Request Example

```json
{
  "external_id": "example-123",
  "requested_action": "sync_record",
  "source_updated_at": "2026-05-09T09:00:00Z"
}
```

## 4. Response Example

```json
{
  "status": "accepted",
  "handoff_id": "handoff-123",
  "next_check_url": "/api/status/handoff-123"
}
```

## 5. Errors And Retries

- Validation errors:
- Auth errors:
- Rate-limit behavior:
- Retry policy:
- Dead-letter or manual review path:

## 6. Logging And Handover

- Logs required:
- PII or sensitive fields:
- Monitoring owner:
- Repository:
- Runbook location:
- Next integration candidate: