Skip to content

config

config

Pydantic models for configuration operations.

ParseConfigRequest

Bases: BaseModel

Request model for parsing configuration.

Source code in hier_config_api/models/config.py 
 8
 9
10
11
12
class ParseConfigRequest(BaseModel):
    """Request model for parsing configuration."""

    platform: str = Field(..., description="Platform type (e.g., cisco_ios, juniper_junos)")
    config_text: str = Field(..., description="Raw configuration text to parse")

ParseConfigResponse

Bases: BaseModel

Response model for parsed configuration.

Source code in hier_config_api/models/config.py 
15
16
17
18
19
class ParseConfigResponse(BaseModel):
    """Response model for parsed configuration."""

    platform: str = Field(..., description="Platform type")
    structured_config: dict[str, Any] = Field(..., description="Structured configuration tree")

CompareConfigRequest

Bases: BaseModel

Request model for comparing configurations.

Source code in hier_config_api/models/config.py 
22
23
24
25
26
27
class CompareConfigRequest(BaseModel):
    """Request model for comparing configurations."""

    platform: str = Field(..., description="Platform type (e.g., cisco_ios, juniper_junos)")
    running_config: str = Field(..., description="Current running configuration")
    intended_config: str = Field(..., description="Desired configuration state")

CompareConfigResponse

Bases: BaseModel

Response model for configuration comparison.

Source code in hier_config_api/models/config.py 
30
31
32
33
34
35
class CompareConfigResponse(BaseModel):
    """Response model for configuration comparison."""

    platform: str = Field(..., description="Platform type")
    unified_diff: str = Field(..., description="Unified diff showing differences")
    has_changes: bool = Field(..., description="Whether there are any differences")

PredictConfigRequest

Bases: BaseModel

Request model for predicting future configuration state.

Source code in hier_config_api/models/config.py 
38
39
40
41
42
43
class PredictConfigRequest(BaseModel):
    """Request model for predicting future configuration state."""

    platform: str = Field(..., description="Platform type (e.g., cisco_ios, juniper_junos)")
    current_config: str = Field(..., description="Current configuration state")
    commands_to_apply: str = Field(..., description="Commands to apply to current config")

PredictConfigResponse

Bases: BaseModel

Response model for predicted configuration.

Source code in hier_config_api/models/config.py 
46
47
48
49
50
51
52
class PredictConfigResponse(BaseModel):
    """Response model for predicted configuration."""

    platform: str = Field(..., description="Platform type")
    predicted_config: str = Field(
        ..., description="Predicted configuration after applying commands"
    )

MergeConfigRequest

Bases: BaseModel

Request model for merging multiple configurations.

Source code in hier_config_api/models/config.py 
55
56
57
58
59
class MergeConfigRequest(BaseModel):
    """Request model for merging multiple configurations."""

    platform: str = Field(..., description="Platform type (e.g., cisco_ios, juniper_junos)")
    configs: list[str] = Field(..., description="List of configuration texts to merge")

MergeConfigResponse

Bases: BaseModel

Response model for merged configuration.

Source code in hier_config_api/models/config.py 
62
63
64
65
66
class MergeConfigResponse(BaseModel):
    """Response model for merged configuration."""

    platform: str = Field(..., description="Platform type")
    merged_config: str = Field(..., description="Merged configuration result")

MatchRule

Bases: BaseModel

Rule for matching configuration lines.

Source code in hier_config_api/models/config.py 
69
70
71
72
73
74
75
class MatchRule(BaseModel):
    """Rule for matching configuration lines."""

    equals: str | None = Field(None, description="Exact match string")
    contains: str | None = Field(None, description="Substring to match")
    startswith: str | None = Field(None, description="Prefix to match")
    regex: str | None = Field(None, description="Regular expression pattern")

SearchConfigRequest

Bases: BaseModel

Request model for searching configuration.

Source code in hier_config_api/models/config.py 
78
79
80
81
82
83
class SearchConfigRequest(BaseModel):
    """Request model for searching configuration."""

    platform: str = Field(..., description="Platform type (e.g., cisco_ios, juniper_junos)")
    config_text: str = Field(..., description="Configuration text to search")
    match_rules: MatchRule = Field(..., description="Rules for matching configuration sections")

SearchConfigResponse

Bases: BaseModel

Response model for configuration search.

Source code in hier_config_api/models/config.py 
86
87
88
89
90
91
class SearchConfigResponse(BaseModel):
    """Response model for configuration search."""

    platform: str = Field(..., description="Platform type")
    matches: list[str] = Field(..., description="Matching configuration sections")
    match_count: int = Field(..., description="Number of matches found")