Validator API Reference¶

class ValidationResult:
    """Represents a policy validation result.

    Attributes:
        valid: Whether validation passed
        errors: List of validation errors
        warnings: List of validation warnings
    """

    def add_error(self, message: str) -> None:
        """Add an error message."""

    def add_warning(self, message: str) -> None:
        """Add a warning message."""

    def as_dict(self) -> Dict[str, Any]:
        """Convert result to dictionary."""

class PolicyValidator:
    """Validates AI participation policies.

    This validator supports two policy formats:
    1. Capability-based policies - Used primarily for testing, with capabilities, 
       conditions, and restrictions
    2. Model-based policies - Used in production, with model types, defaults, and paths

    Attributes:
        REQUIRED_FIELDS: Set of required fields in policy
        OPTIONAL_FIELDS: Set of optional fields in policy
        MODEL_REQUIREMENTS: Valid requirements for each model
        MODEL_ACTIONS: Valid actions for each model
    """

    def validate_file(self, path: Union[str, Path], strict: bool = False) -> ValidationResult:
        """Validate a policy file."""

    def validate_policy(self, policy: Dict[str, Any], strict: bool = False) -> ValidationResult:
        """Validate policy data.

        Supports both capability-based policies (for testing) and model-based policies
        (for production).
        """

# Validate a policy file
validator = PolicyValidator()
result = validator.validate_file("aria-policy.yml")
if result.valid:
    print("Policy is valid")
else:
    print("Errors:", result.errors)
    print("Warnings:", result.warnings)

# Validate a policy dictionary with strict validation
policy_data = {
    "version": "1.0.0",
    "name": "Test Policy",
    "description": "A comprehensive test policy.",
    "capabilities": [
        {
            "name": "test_capability",
            "description": "A detailed test capability description.",
            "allowed": True,
            "conditions": ["Must follow all testing guidelines."]
        }
    ],
    "restrictions": ["No unauthorized testing."]
}
result = validator.validate_policy(policy_data, strict=True)
if result.valid:
    print("Policy is valid")
    if result.warnings:
        print("Warnings:", result.warnings)
else:
    print("Errors:", result.errors)