Skip to content

platform

platform

Pydantic models for platform information.

PlatformInfo

Bases: BaseModel

Information about a supported platform.

Source code in hier_config_api/models/platform.py 
 8
 9
10
11
12
13
14
class PlatformInfo(BaseModel):
    """Information about a supported platform."""

    platform_name: str = Field(..., description="Platform identifier")
    display_name: str = Field(..., description="Human-readable platform name")
    vendor: str = Field(..., description="Vendor name")
    supported: bool = Field(True, description="Whether platform is currently supported")

PlatformRules

Bases: BaseModel

Platform-specific rules and behaviors.

Source code in hier_config_api/models/platform.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class PlatformRules(BaseModel):
    """Platform-specific rules and behaviors."""

    platform_name: str = Field(..., description="Platform identifier")
    negation_default_when: list[str] = Field(
        default_factory=list, description="Default negation patterns for when conditions"
    )
    negation_negate_with: list[str] = Field(
        default_factory=list, description="How to negate specific commands"
    )
    ordering: list[dict[str, Any]] = Field(
        default_factory=list, description="Command ordering rules"
    )
    idempotent_commands_avoid: list[str] = Field(
        default_factory=list, description="Commands to avoid in idempotent configs"
    )
    idempotent_commands: list[str] = Field(
        default_factory=list, description="Commands that are idempotent"
    )

ValidateConfigRequest

Bases: BaseModel

Request model for validating configuration.

Source code in hier_config_api/models/platform.py 
38
39
40
41
class ValidateConfigRequest(BaseModel):
    """Request model for validating configuration."""

    config_text: str = Field(..., description="Configuration text to validate")

ValidateConfigResponse

Bases: BaseModel

Response model for configuration validation.

Source code in hier_config_api/models/platform.py 
44
45
46
47
48
49
50
class ValidateConfigResponse(BaseModel):
    """Response model for configuration validation."""

    platform: str = Field(..., description="Platform type")
    is_valid: bool = Field(..., description="Whether configuration is valid")
    warnings: list[str] = Field(default_factory=list, description="Validation warnings")
    errors: list[str] = Field(default_factory=list, description="Validation errors")

BatchJobRequest

Bases: BaseModel

Request model for batch job.

Source code in hier_config_api/models/platform.py 
53
54
55
56
class BatchJobRequest(BaseModel):
    """Request model for batch job."""

    device_configs: list[dict[str, Any]] = Field(..., description="List of device configurations")

BatchJobResponse

Bases: BaseModel

Response model for batch job creation.

Source code in hier_config_api/models/platform.py 
59
60
61
62
63
class BatchJobResponse(BaseModel):
    """Response model for batch job creation."""

    job_id: str = Field(..., description="Unique job identifier")
    total_devices: int = Field(..., description="Total number of devices in batch")

BatchJobStatus

Bases: BaseModel

Status of a batch job.

Source code in hier_config_api/models/platform.py 
66
67
68
69
70
71
72
73
74
class BatchJobStatus(BaseModel):
    """Status of a batch job."""

    job_id: str = Field(..., description="Job identifier")
    status: str = Field(..., description="Job status (pending, running, completed, failed)")
    progress: float = Field(0.0, description="Progress percentage (0.0 to 100.0)", ge=0.0, le=100.0)
    total_devices: int = Field(..., description="Total number of devices")
    completed_devices: int = Field(0, description="Number of completed devices")
    failed_devices: int = Field(0, description="Number of failed devices")

BatchJobResults

Bases: BaseModel

Results of a completed batch job.

Source code in hier_config_api/models/platform.py 
77
78
79
80
81
82
83
class BatchJobResults(BaseModel):
    """Results of a completed batch job."""

    job_id: str = Field(..., description="Job identifier")
    status: str = Field(..., description="Job status")
    results: list[dict[str, Any]] = Field(..., description="Results for each device")
    summary: dict[str, Any] = Field(..., description="Summary statistics")