infrahub-server 1.6.3__py3-none-any.whl → 1.7.0__py3-none-any.whl

infrahub/core/schema/definitions/core/propose_change_validator.py

@@ -22,7 +22,7 @@ from ...relationship_schema import (
 core_propose_change_validator = GenericSchema(
     name="Validator",
     namespace="Core",
-    description="",
+    description="A validator that runs checks against a proposed change",
     include_in_menu=False,
     label="Validator",
     order_by=["started_at__value"],
@@ -31,16 +31,21 @@ core_propose_change_validator = GenericSchema(
     attributes=[
         Attr(name="label", kind="Text", optional=True),
         Attr(
-            name="state", kind="Text", enum=ValidatorState.available_types(), default_value=ValidatorState.QUEUED.value
+            name="state",
+            kind="Text",
+            description="Current execution state of the validator",
+            enum=ValidatorState.available_types(),
+            default_value=ValidatorState.QUEUED.value,
         ),
         Attr(
             name="conclusion",
             kind="Text",
+            description="Final outcome of the validation",
             enum=ValidatorConclusion.available_types(),
             default_value=ValidatorConclusion.UNKNOWN.value,
         ),
-        Attr(name="completed_at", kind="DateTime", optional=True),
-        Attr(name="started_at", kind="DateTime", optional=True),
+        Attr(name="completed_at", kind="DateTime", description="Timestamp when the validator finished", optional=True),
+        Attr(name="started_at", kind="DateTime", description="Timestamp when the validator started", optional=True),
     ],
     relationships=[
         Rel(
@@ -186,7 +191,7 @@ core_generator_validator = NodeSchema(
 core_check = GenericSchema(
     name="Check",
     namespace="Core",
-    description="",
+    description="A check result within a validator that reports on specific validation outcomes",
     display_labels=["label__value"],
     include_in_menu=False,
     label="Check",
@@ -194,19 +199,21 @@ core_check = GenericSchema(
     attributes=[
         Attr(name="name", kind="Text", optional=True),
         Attr(name="label", kind="Text", optional=True),
-        Attr(name="origin", kind="Text", optional=False),
+        Attr(name="origin", kind="Text", description="Source that created this check", optional=False),
         Attr(
             name="kind",
             kind="Text",
+            description="Type of check being performed",
             regex=r"^[A-Z][a-zA-Z0-9]+$",
             optional=False,
             min_length=DEFAULT_KIND_MIN_LENGTH,
             max_length=DEFAULT_KIND_MAX_LENGTH,
         ),
-        Attr(name="message", kind="TextArea", optional=True),
+        Attr(name="message", kind="TextArea", description="Detailed message about the check result", optional=True),
         Attr(
             name="conclusion",
             kind="Text",
+            description="Outcome of the check",
             enum=ValidatorConclusion.available_types(),
             default_value=ValidatorConclusion.UNKNOWN.value,
             optional=True,
@@ -214,11 +221,12 @@ core_check = GenericSchema(
         Attr(
             name="severity",
             kind="Text",
+            description="Severity level of any issues found",
             enum=Severity.available_types(),
             default_value=Severity.INFO.value,
             optional=True,
         ),
-        Attr(name="created_at", kind="DateTime", optional=True),
+        Attr(name="created_at", kind="DateTime", description="Timestamp when the check was created", optional=True),
     ],
     relationships=[
         Rel(
@@ -243,9 +251,20 @@ core_data_check = NodeSchema(
     generate_profile=False,
     branch=BranchSupportType.AGNOSTIC,
     attributes=[
-        Attr(name="conflicts", kind="JSON"),
-        Attr(name="keep_branch", kind="Text", enum=BranchConflictKeep.available_types(), optional=True),
-        Attr(name="enriched_conflict_id", kind="Text", optional=True),
+        Attr(name="conflicts", kind="JSON", description="Details of detected data conflicts between branches"),
+        Attr(
+            name="keep_branch",
+            kind="Text",
+            description="Which branch data to keep when resolving conflicts",
+            enum=BranchConflictKeep.available_types(),
+            optional=True,
+        ),
+        Attr(
+            name="enriched_conflict_id",
+            kind="Text",
+            description="Unique identifier for the enriched conflict",
+            optional=True,
+        ),
     ],
 )
 
@@ -272,8 +291,13 @@ core_schema_check = NodeSchema(
     generate_profile=False,
     branch=BranchSupportType.AGNOSTIC,
     attributes=[
-        Attr(name="conflicts", kind="JSON"),
-        Attr(name="enriched_conflict_id", kind="Text", optional=True),
+        Attr(name="conflicts", kind="JSON", description="Details of detected schema conflicts"),
+        Attr(
+            name="enriched_conflict_id",
+            kind="Text",
+            description="Unique identifier for the enriched conflict",
+            optional=True,
+        ),
     ],
 )
 
@@ -288,8 +312,8 @@ core_file_check = NodeSchema(
     generate_profile=False,
     branch=BranchSupportType.AGNOSTIC,
     attributes=[
-        Attr(name="files", kind="List", optional=True),
-        Attr(name="commit", kind="Text", optional=True),
+        Attr(name="files", kind="List", description="List of files involved in this check", optional=True),
+        Attr(name="commit", kind="Text", description="Git commit hash associated with this check", optional=True),
     ],
 )
 
@@ -304,11 +328,11 @@ core_artifact_check = NodeSchema(
     generate_profile=False,
     branch=BranchSupportType.AGNOSTIC,
     attributes=[
-        Attr(name="changed", kind="Boolean", optional=True),
-        Attr(name="checksum", kind="Text", optional=True),
-        Attr(name="artifact_id", kind="Text", optional=True),
-        Attr(name="storage_id", kind="Text", optional=True),
-        Attr(name="line_number", kind="Number", optional=True),
+        Attr(name="changed", kind="Boolean", description="Whether the artifact content has changed", optional=True),
+        Attr(name="checksum", kind="Text", description="Hash checksum of the artifact content", optional=True),
+        Attr(name="artifact_id", kind="Text", description="Unique identifier of the artifact", optional=True),
+        Attr(name="storage_id", kind="Text", description="ID of the artifact in the object store", optional=True),
+        Attr(name="line_number", kind="Number", description="Line number reference for artifact issues", optional=True),
     ],
 )
 
@@ -323,6 +347,11 @@ core_generator_check = NodeSchema(
     generate_profile=False,
     branch=BranchSupportType.AGNOSTIC,
     attributes=[
-        Attr(name="instance", kind="Text", optional=False),
+        Attr(
+            name="instance",
+            kind="Text",
+            description="Identifier of the generator instance being checked",
+            optional=False,
+        ),
     ],
 )

infrahub/core/schema/definitions/core/repository.py

@@ -40,12 +40,14 @@ core_repository = NodeSchema(
         Attr(
             name="default_branch",
             kind="Text",
+            description="Default branch name in the Git repository",
             default_value="main",
             order_weight=6000,
         ),
         Attr(
             name="commit",
             kind="Text",
+            description="Current commit hash being tracked",
             optional=True,
             branch=BranchSupportType.LOCAL,
             order_weight=7000,
@@ -75,6 +77,7 @@ core_read_only_repository = NodeSchema(
         Attr(
             name="ref",
             kind="Text",
+            description="Git reference (branch or tag) to track",
             default_value="main",
             branch=BranchSupportType.AWARE,
             order_weight=6000,
@@ -82,6 +85,7 @@ core_read_only_repository = NodeSchema(
         Attr(
             name="commit",
             kind="Text",
+            description="Current commit hash being tracked",
             optional=True,
             branch=BranchSupportType.AWARE,
             order_weight=7000,
@@ -107,6 +111,7 @@ core_generic_repository = GenericSchema(
             name="name",
             regex=r"^[^/]*$",
             kind="Text",
+            description="Unique name identifier for the repository",
             unique=True,
             branch=BranchSupportType.AGNOSTIC,
             order_weight=1000,
@@ -115,6 +120,7 @@ core_generic_repository = GenericSchema(
         Attr(
             name="description",
             kind="Text",
+            description="Description of the repository",
             optional=True,
             branch=BranchSupportType.AGNOSTIC,
             order_weight=2000,
@@ -123,6 +129,7 @@ core_generic_repository = GenericSchema(
         Attr(
             name="location",
             kind="Text",
+            description="URL or path to the Git repository",
             unique=True,
             branch=BranchSupportType.AGNOSTIC,
             order_weight=3000,
@@ -131,6 +138,7 @@ core_generic_repository = GenericSchema(
         Attr(
             name="internal_status",
             kind="Dropdown",
+            description="Internal status of the repository on this branch",
             choices=[
                 DropdownChoice(
                     name=RepositoryInternalStatus.STAGING.value,
@@ -160,6 +168,7 @@ core_generic_repository = GenericSchema(
         Attr(
             name="operational_status",
             kind="Dropdown",
+            description="Connectivity status of the repository",
             choices=[
                 DropdownChoice(
                     name=RepositoryOperationalStatus.UNKNOWN.value,
@@ -200,6 +209,7 @@ core_generic_repository = GenericSchema(
         Attr(
             name="sync_status",
             kind="Dropdown",
+            description="Current synchronization status of the repository",
             choices=[
                 DropdownChoice(
                     name=RepositorySyncStatus.UNKNOWN.value,

infrahub/core/schema/definitions/core/resource_pool.py

@@ -73,12 +73,19 @@ core_ip_prefix_pool = NodeSchema(
         Attr(
             name="default_member_type",
             kind="Text",
+            description="Default member type for allocated prefixes",
             enum=["prefix", "address"],
             default_value="prefix",
             optional=True,
             order_weight=3000,
         ),
-        Attr(name="default_prefix_type", kind="Text", optional=True, order_weight=4000),
+        Attr(
+            name="default_prefix_type",
+            kind="Text",
+            description="Default prefix type schema to use when allocating",
+            optional=True,
+            order_weight=4000,
+        ),
     ],
     relationships=[
         Rel(

infrahub/core/schema/definitions/core/template.py

@@ -11,7 +11,16 @@ core_object_template = GenericSchema(
     display_labels=["template_name__value"],
     default_filter="template_name__value",
     uniqueness_constraints=[["template_name__value"]],
-    attributes=[Attr(name="template_name", kind="Text", optional=False, unique=True, order_weight=1000)],
+    attributes=[
+        Attr(
+            name="template_name",
+            kind="Text",
+            description="Unique name identifier for the template",
+            optional=False,
+            unique=True,
+            order_weight=1000,
+        )
+    ],
 )
 
 core_object_component_template = GenericSchema(
@@ -23,5 +32,13 @@ core_object_component_template = GenericSchema(
     label="Object Component Templates",
     display_labels=["template_name__value"],
     default_filter="template_name__value",
-    attributes=[Attr(name="template_name", kind="Text", optional=False, order_weight=1000)],
+    attributes=[
+        Attr(
+            name="template_name",
+            kind="Text",
+            description="Name identifier for the component template",
+            optional=False,
+            order_weight=1000,
+        )
+    ],
 )

infrahub/core/schema/definitions/core/transform.py

@@ -29,7 +29,7 @@ core_transform = GenericSchema(
         Attr(name="name", kind="Text", unique=True),
         Attr(name="label", kind="Text", optional=True),
         Attr(name="description", kind="Text", optional=True),
-        Attr(name="timeout", kind="Number", default_value=60),
+        Attr(name="timeout", kind="Number", description="Maximum execution time in seconds", default_value=60),
     ],
     relationships=[
         Rel(
@@ -72,7 +72,7 @@ core_transform_jinja2 = NodeSchema(
     branch=BranchSupportType.AWARE,
     documentation="/topics/transformation",
     attributes=[
-        Attr(name="template_path", kind="Text"),
+        Attr(name="template_path", kind="Text", description="Path to the Jinja2 template file in the repository"),
     ],
 )
 
@@ -90,8 +90,14 @@ core_transform_python = NodeSchema(
     branch=BranchSupportType.AWARE,
     documentation="/topics/transformation",
     attributes=[
-        Attr(name="file_path", kind="Text"),
-        Attr(name="class_name", kind="Text"),
-        Attr(name="convert_query_response", kind="Boolean", optional=True, default_value=False),
+        Attr(name="file_path", kind="Text", description="Path to the Python file in the repository"),
+        Attr(name="class_name", kind="Text", description="Name of the Python class implementing the transformation"),
+        Attr(
+            name="convert_query_response",
+            kind="Boolean",
+            description="Whether to convert the GraphQL response to SDK objects",
+            optional=True,
+            default_value=False,
+        ),
     ],
 )

infrahub/core/schema/definitions/core/webhook.py

@@ -37,9 +37,18 @@ core_webhook = GenericSchema(
             order_weight=1500,
             description="The event type that triggers the webhook",
         ),
+        Attr(
+            name="active",
+            kind="Boolean",
+            description="Indicates if this webhook is enabled",
+            optional=False,
+            default_value=True,
+            order_weight=1750,
+        ),
         Attr(
             name="branch_scope",
             kind="Dropdown",
+            description="Which branches should trigger this webhook",
             choices=[
                 DropdownChoice(
                     name="all_branches",
@@ -72,16 +81,12 @@ core_webhook = GenericSchema(
             description="Only send node mutation events for nodes of this kind",
             order_weight=2250,
         ),
-        Attr(
-            name="description",
-            kind="Text",
-            optional=True,
-            order_weight=2500,
-        ),
-        Attr(name="url", kind="URL", order_weight=3000),
+        Attr(name="description", kind="Text", optional=True, order_weight=2500),
+        Attr(name="url", kind="URL", description="Target URL to send webhook requests to", order_weight=3000),
         Attr(
             name="validate_certificates",
             kind="Boolean",
+            description="Whether to validate SSL/TLS certificates",
             default_value=True,
             optional=True,
             order_weight=5000,
@@ -103,7 +108,13 @@ core_standard_webhook = NodeSchema(
     generate_profile=False,
     inherit_from=[InfrahubKind.WEBHOOK, InfrahubKind.TASKTARGET],
     attributes=[
-        Attr(name="shared_key", kind="Password", unique=False, order_weight=4000),
+        Attr(
+            name="shared_key",
+            kind="Password",
+            description="Shared secret key for webhook authentication",
+            unique=False,
+            order_weight=4000,
+        ),
     ],
 )
 
@@ -121,7 +132,14 @@ core_custom_webhook = NodeSchema(
     generate_profile=False,
     inherit_from=[InfrahubKind.WEBHOOK, InfrahubKind.TASKTARGET],
     attributes=[
-        Attr(name="shared_key", kind="Password", unique=False, optional=True, order_weight=4000),
+        Attr(
+            name="shared_key",
+            kind="Password",
+            description="Shared secret key for webhook authentication",
+            unique=False,
+            optional=True,
+            order_weight=4000,
+        ),
     ],
     relationships=[
         Rel(