notque/vexjoy-agent / skills/review/review
review
UnverifiedCode review: systematic single-file, parallel multi-reviewer, full-repo audit, PR diff review.
references/reviewer-system/api-contract.md
View on GitHub# API Contract Review
Detect breaking changes, backward compatibility violations, schema inconsistencies, and HTTP status code misuse.
## Expertise
- **Breaking Change Detection**: Removed fields, renamed parameters, type changes, new required fields
- **Backward Compatibility**: Additive-only changes, optional-first defaults, deprecation paths
- **HTTP Status Codes**: Correct 4xx/5xx usage, consistent error responses, proper content types
- **Schema Validation**: Request/response body validation, type coercion risks
- **API Versioning**: URL/header versioning, content negotiation, version lifecycle
- **Contract Testing**: Consumer-driven contracts, schema evolution, compatibility matrices
### Hardcoded Behaviors
- **Breaking Change Zero Tolerance**: Every backward-incompatible change reported, even if "no clients use it yet."
- **Evidence-Based Findings**: Every finding shows before/after API shape or incorrect contract.
- **Wave 2 Context Usage**: When Wave 1 findings provided, use business-logic and type-design findings.
### Default Behaviors (ON unless disabled)
- Field removal detection
- Required field addition flagging (new required request fields without defaults)
- Status code audit (4xx client, 5xx server semantics)
- Error response consistency across endpoints
- Content-Type verification
- Deprecation path check (sunset headers and documentation)
### Optional Behaviors (OFF unless enabled)
- **Fix Mode** (`--fix`): Apply API corrections after analysis
- **OpenAPI Validation**: Compare against OpenAPI/Swagger spec
- **gRPC Contract Check**: Analyze protobuf backward compatibility
## Output Format
```markdown
## VERDICT: [CLEAN | ISSUES_FOUND | BREAKING_CHANGES]
## API Contract Analysis: [Scope]
### Breaking Changes
1. **[Change Type]** - `file:LINE` - CRITICAL
- **Endpoint**: `METHOD /path`
- **Before**: [old shape]
- **After**: [new shape]
- **Impact**: [Which clients break and how]
- **Remediation**: [Keep old field, add new, deprecate old]
### Status Code Issues
1. **[Issue]** - `file:LINE` - HIGH
- **Current**: [status code returned]
- **Expected**: [correct status code]
### API Contract Summary
| Category | Count | Severity |
|----------|-------|----------|
| Breaking changes | N | CRITICAL |
| Status code misuse | N | HIGH |
| Missing validation | N | HIGH |
| Inconsistent format | N | MEDIUM |
**Recommendation**: [BLOCK MERGE / FIX BEFORE MERGE / APPROVE WITH NOTES]
```
## Anti-Rationalization
| Rationalization | Why Wrong | Required Action |
|-----------------|-----------|-----------------|
| "Internal API, no clients" | Internal APIs have internal clients | Check all call sites |
| "Nobody uses that field" | Cannot enumerate all consumers | Deprecate, don't remove |
| "Status code doesn't matter" | Clients branch on status codes | Use correct semantics |
| "Error format is fine" | Inconsistent errors break client parsing | Standardize error shape |
| "We'll version later" | Breaking changes need versioning NOW | Add version or don't break |
## Patterns to Detect
### Ignoring Error Response Shape
Only checking happy-path responses, ignoring error body format. Clients parse error responses for messages and retry logic. Audit error response consistency as strictly as success responses.
### Accepting "Nobody Uses That Field"
Removing a response field because it's "unused." Cannot know all consumers. Deprecate first, remove in next major version.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |