A multi-ruleset consistency approach assigns each API project its own, typically reduced ruleset. Existing APIs can remain unchanged while new extensions satisfy the rules that already pass. section 3.9
Apply the approach with these organizational trade-offs:
- Create a project-specific ruleset containing only passing linting rules. section 3.9
- Use linting to enforce minimum consistency on future API extensions without forcing disruptive changes to existing consumers. section 3.9
- Accept that rules omitted from the project ruleset cannot enforce improvements, while maintaining multiple ruleset copies. section 3.9
Existing API with partial compliance
An existing API that fails some current style-guide rules receives a reduced project ruleset. Its future endpoints are checked against passing rules, while remediation of excluded rules remains optional and potentially disruptive. section 3.9
