📋 Rules Guide
Complete reference for all 11 linting rules implemented in Linterman.
11
Total Rules
4
ERROR Rules
7
WARNING Rules
5
Auto-Fixable
❌ ERROR Rules (Critical)
These issues must be fixed. Impact: -15% per issue
HTTP Status Test Mandatory
ERROR Auto-FixEvery request must test the HTTP status code
Testing-15%
Test Description with URI
ERROR Auto-FixTest descriptions should include URI segments or use location variable
Testing-15%
Collection Documentation
ERRORCollection must have complete Overview documentation
Documentation-15%
Request Examples Required
ERROREach request must have quality response examples
Documentation-15%
⚠️ WARNING Rules (Important)
These issues should be fixed. Impact: -8% per issue
Response Time Test Mandatory
WARNING Auto-FixEach request should test response time
Testing-8%
Body Content Validation
WARNINGRequests should validate response body content
Testing-8%
Schema Validation Recommended
WARNINGJSON schema validation recommended for robustness
Testing-8%
Request Naming Convention
WARNING Auto-FixRequests should start with HTTP method
Structure-8%
Response Time Threshold
WARNING Auto-FixResponse time thresholds should be reasonable (≤2000ms)
Performance-8%
Environment Variables Usage
WARNINGURLs should use environment variables
Best Practices-8%
Test Coverage Minimum
WARNINGCollection should have minimum 80% test coverage
Best Practices-8%
🔧 Auto-Fix Summary
5/11 rules can be fixed automatically (45%).
Auto-Fixable Rules:
- HTTP Status Test Mandatory
- Test Description with URI
- Response Time Test Mandatory
- Request Naming Convention
- Response Time Threshold
🎯 Achieving 100% Score
- ✅ Fix all ERROR rules (priority)
- ✅ Use auto-fix for the 5 supported rules
- ✅ Manually fix the remaining 6 rules
- ✅ Get the bonus: 0 errors AND ≤ 2 warnings = +5%