infrahub-server 1.7.0b0__py3-none-any.whl → 1.7.0rc0__py3-none-any.whl

infrahub/core/schema/definitions/core/check.py

@@ -14,6 +14,7 @@ from ...relationship_schema import (
 core_check_definition = NodeSchema(
     name="CheckDefinition",
     namespace="Core",
+    description="Defines a user-defined check that validates data in a proposed change",
     include_in_menu=False,
     icon="mdi:check-all",
     label="Check Definition",
@@ -27,10 +28,15 @@ core_check_definition = NodeSchema(
     attributes=[
         Attr(name="name", kind="Text", unique=True),
         Attr(name="description", kind="Text", optional=True),
-        Attr(name="file_path", kind="Text"),
-        Attr(name="class_name", kind="Text"),
-        Attr(name="timeout", kind="Number", default_value=60),
-        Attr(name="parameters", kind="JSON", optional=True),
+        Attr(name="file_path", kind="Text", description="Path to the Python file containing the check class"),
+        Attr(name="class_name", kind="Text", description="Name of the Python class implementing the check"),
+        Attr(
+            name="timeout",
+            kind="Number",
+            description="Maximum execution time in seconds before the check times out",
+            default_value=60,
+        ),
+        Attr(name="parameters", kind="JSON", description="Additional parameters to pass to the check", optional=True),
     ],
     relationships=[
         Rel(

infrahub/core/schema/definitions/core/generator.py

@@ -15,6 +15,7 @@ from ...relationship_schema import (
 core_generator_definition = NodeSchema(
     name="GeneratorDefinition",
     namespace="Core",
+    description="Defines a generator that creates or updates objects based on a GraphQL query",
     include_in_menu=False,
     icon="mdi:state-machine",
     label="Generator Definition",
@@ -29,12 +30,30 @@ core_generator_definition = NodeSchema(
     attributes=[
         Attr(name="name", kind="Text", unique=True),
         Attr(name="description", kind="Text", optional=True),
-        Attr(name="parameters", kind="JSON"),
-        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="execute_in_proposed_change", kind="Boolean", optional=True, default_value=True),
-        Attr(name="execute_after_merge", kind="Boolean", optional=True, default_value=True),
+        Attr(name="parameters", kind="JSON", description="GraphQL query parameters for the generator"),
+        Attr(name="file_path", kind="Text", description="Path to the Python file containing the generator class"),
+        Attr(name="class_name", kind="Text", description="Name of the Python class implementing the generator"),
+        Attr(
+            name="convert_query_response",
+            kind="Boolean",
+            description="Whether to convert the GraphQL response to SDK objects",
+            optional=True,
+            default_value=False,
+        ),
+        Attr(
+            name="execute_in_proposed_change",
+            kind="Boolean",
+            description="Whether to run this generator in proposed changes",
+            optional=True,
+            default_value=True,
+        ),
+        Attr(
+            name="execute_after_merge",
+            kind="Boolean",
+            description="Whether to run this generator after a merge",
+            optional=True,
+            default_value=True,
+        ),
     ],
     relationships=[
         Rel(
@@ -67,6 +86,7 @@ core_generator_definition = NodeSchema(
 core_generator_instance = NodeSchema(
     name="GeneratorInstance",
     namespace="Core",
+    description="An instance of a generator execution for a specific object",
     label="Generator Instance",
     include_in_menu=False,
     icon="mdi:file-document-outline",

infrahub/core/schema/definitions/core/graphql_query.py

@@ -28,7 +28,7 @@ core_graphql_query = NodeSchema(
     attributes=[
         Attr(name="name", kind="Text", unique=True),
         Attr(name="description", kind="Text", optional=True),
-        Attr(name="query", kind="TextArea"),
+        Attr(name="query", kind="TextArea", description="The GraphQL query string"),
         Attr(name="variables", kind="JSON", description="variables in use in the query", optional=True, read_only=True),
         Attr(
             name="operations",

infrahub/core/schema/definitions/core/group.py

@@ -31,7 +31,14 @@ core_group = GenericSchema(
         Attr(name="name", kind="Text", unique=True),
         Attr(name="label", kind="Text", optional=True),
         Attr(name="description", kind="Text", optional=True),
-        Attr(name="group_type", kind="Text", enum=["default", "internal"], default_value="default", optional=False),
+        Attr(
+            name="group_type",
+            kind="Text",
+            description="Type of group (default or internal)",
+            enum=["default", "internal"],
+            default_value="default",
+            optional=False,
+        ),
     ],
     relationships=[
         Rel(
@@ -111,7 +118,7 @@ core_graphql_query_group = NodeSchema(
     inherit_from=[InfrahubKind.GENERICGROUP],
     generate_profile=False,
     attributes=[
-        Attr(name="parameters", kind="JSON", optional=True),
+        Attr(name="parameters", kind="JSON", description="GraphQL query parameters for the group", optional=True),
     ],
     relationships=[
         Rel(

infrahub/core/schema/definitions/core/ipam.py

@@ -68,11 +68,18 @@ builtin_ip_prefix = GenericSchema(
     branch=BranchSupportType.AWARE,
     hierarchical=True,
     attributes=[
-        Attr(name="prefix", kind="IPNetwork", branch=BranchSupportType.AWARE, order_weight=1000),
+        Attr(
+            name="prefix",
+            kind="IPNetwork",
+            description="The IP prefix in CIDR notation",
+            branch=BranchSupportType.AWARE,
+            order_weight=1000,
+        ),
         Attr(name="description", kind="Text", optional=True, branch=BranchSupportType.AWARE, order_weight=2000),
         Attr(
             name="member_type",
             kind="Dropdown",
+            description="Whether this prefix contains other prefixes or IP addresses",
             choices=[
                 DropdownChoice(
                     name="prefix",
@@ -97,13 +104,53 @@ builtin_ip_prefix = GenericSchema(
             order_weight=4000,
             description="All IP addresses within this prefix are considered usable",
         ),
-        Attr(name="is_top_level", kind="Boolean", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
-        Attr(name="utilization", kind="Number", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
-        Attr(name="netmask", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
-        Attr(name="hostmask", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
-        Attr(name="network_address", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
         Attr(
-            name="broadcast_address", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE
+            name="is_top_level",
+            kind="Boolean",
+            description="Whether this prefix has no parent prefix",
+            read_only=True,
+            optional=True,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Attr(
+            name="utilization",
+            kind="Number",
+            description="Percentage of the prefix that is allocated",
+            read_only=True,
+            optional=True,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Attr(
+            name="netmask",
+            kind="Text",
+            description="Subnet mask in dotted decimal notation",
+            read_only=True,
+            optional=True,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Attr(
+            name="hostmask",
+            kind="Text",
+            description="Wildcard mask in dotted decimal notation",
+            read_only=True,
+            optional=True,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Attr(
+            name="network_address",
+            kind="Text",
+            description="Network address of the prefix",
+            read_only=True,
+            optional=True,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Attr(
+            name="broadcast_address",
+            kind="Text",
+            description="Broadcast address of the prefix",
+            read_only=True,
+            optional=True,
+            allow_override=AllowOverrideType.NONE,
         ),
     ],
     relationships=[
@@ -150,7 +197,13 @@ builtin_ip_address = GenericSchema(
     icon="mdi:ip-outline",
     branch=BranchSupportType.AWARE,
     attributes=[
-        Attr(name="address", kind="IPHost", branch=BranchSupportType.AWARE, order_weight=1000),
+        Attr(
+            name="address",
+            kind="IPHost",
+            description="The IP address with prefix length",
+            branch=BranchSupportType.AWARE,
+            order_weight=1000,
+        ),
         Attr(name="description", kind="Text", optional=True, branch=BranchSupportType.AWARE, order_weight=2000),
     ],
     relationships=[
@@ -186,7 +239,15 @@ internal_ipam_ip_range_available = NodeSchema(
     branch=BranchSupportType.AWARE,
     inherit_from=[InfrahubKind.IPADDRESS],
     generate_profile=False,
-    attributes=[Attr(name="last_address", kind="IPHost", branch=BranchSupportType.AWARE, order_weight=2000)],
+    attributes=[
+        Attr(
+            name="last_address",
+            kind="IPHost",
+            description="Last IP address in the available range",
+            branch=BranchSupportType.AWARE,
+            order_weight=2000,
+        )
+    ],
 )
 
 internal_ipam_ip_prefix_available = NodeSchema(
@@ -215,5 +276,14 @@ core_ipam_namespace = NodeSchema(
     icon="mdi:format-list-group",
     branch=BranchSupportType.AWARE,
     inherit_from=[InfrahubKind.IPNAMESPACE],
-    attributes=[Attr(name="default", kind="Boolean", optional=True, read_only=True, order_weight=9000)],
+    attributes=[
+        Attr(
+            name="default",
+            kind="Boolean",
+            description="Whether this is the default IPAM namespace",
+            optional=True,
+            read_only=True,
+            order_weight=9000,
+        )
+    ],
 )

infrahub/core/schema/definitions/core/menu.py

@@ -17,19 +17,53 @@ generic_menu_item = GenericSchema(
     display_labels=["label__value"],
     generate_profile=False,
     attributes=[
-        Attr(name="namespace", kind="Text", regex=NAMESPACE_REGEX, order_weight=1000),
+        Attr(
+            name="namespace",
+            kind="Text",
+            description="Namespace for the menu item",
+            regex=NAMESPACE_REGEX,
+            order_weight=1000,
+        ),
         Attr(name="name", kind="Text", order_weight=1000),
         Attr(name="label", kind="Text", optional=True, order_weight=2000),
-        Attr(name="kind", kind="Text", optional=True, order_weight=2500),
-        Attr(name="path", kind="Text", optional=True, order_weight=2500),
+        Attr(
+            name="kind",
+            kind="Text",
+            description="Kind of object this menu item links to",
+            optional=True,
+            order_weight=2500,
+        ),
+        Attr(name="path", kind="Text", description="URL path for the menu item", optional=True, order_weight=2500),
         Attr(name="description", kind="Text", optional=True, order_weight=3000),
-        Attr(name="icon", kind="Text", optional=True, order_weight=4000),
-        Attr(name="protected", kind="Boolean", default_value=False, read_only=True, order_weight=5000),
-        Attr(name="order_weight", kind="Number", default_value=2000, order_weight=6000),
-        Attr(name="required_permissions", kind="List", optional=True, order_weight=7000),
+        Attr(
+            name="icon", kind="Text", description="Icon identifier for the menu item", optional=True, order_weight=4000
+        ),
+        Attr(
+            name="protected",
+            kind="Boolean",
+            description="Whether the menu item is protected from modification",
+            default_value=False,
+            read_only=True,
+            order_weight=5000,
+        ),
+        Attr(
+            name="order_weight",
+            kind="Number",
+            description="Ordering weight for menu item placement",
+            default_value=2000,
+            order_weight=6000,
+        ),
+        Attr(
+            name="required_permissions",
+            kind="List",
+            description="List of permissions required to view this menu item",
+            optional=True,
+            order_weight=7000,
+        ),
         Attr(
             name="section",
             kind="Text",
+            description="Section where the menu item appears",
             enum=["object", "internal"],
             default_value="object",
             order_weight=8000,

infrahub/core/schema/definitions/core/permission.py

@@ -27,7 +27,14 @@ core_base_permission = GenericSchema(
     generate_profile=False,
     attributes=[
         Attr(name="description", kind="Text", optional=True),
-        Attr(name="identifier", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
+        Attr(
+            name="identifier",
+            kind="Text",
+            description="Identifier for the permission",
+            read_only=True,
+            optional=True,
+            allow_override=AllowOverrideType.NONE,
+        ),
     ],
     relationships=[
         Rel(
@@ -54,11 +61,17 @@ core_object_permission = NodeSchema(
     generate_profile=False,
     inherit_from=[InfrahubKind.BASEPERMISSION],
     attributes=[
-        Attr(name="namespace", kind="Text", order_weight=2000),
+        Attr(
+            name="namespace",
+            kind="Text",
+            description="Namespace of the object type this permission applies to",
+            order_weight=2000,
+        ),
         Attr(name="name", kind="Text", order_weight=3000),
         Attr(
             name="action",
             kind="Text",
+            description="The action this permission grants or denies",
             enum=PermissionAction.available_types(),
             default_value=PermissionAction.ANY.value,
             order_weight=4000,
@@ -91,6 +104,7 @@ core_global_permission = NodeSchema(
         Attr(
             name="action",
             kind="Dropdown",
+            description="The global action this permission grants or denies",
             choices=[DropdownChoice(name=permission.value) for permission in GlobalPermissions],
             order_weight=2000,
         ),

infrahub/core/schema/definitions/core/profile.py

@@ -12,7 +12,21 @@ core_profile_schema_definition = GenericSchema(
     default_filter="profile_name__value",
     uniqueness_constraints=[["profile_name__value"]],
     attributes=[
-        Attr(name="profile_name", kind="Text", min_length=3, max_length=32, unique=True, optional=False),
-        Attr(name="profile_priority", kind="Number", default_value=1000, optional=True),
+        Attr(
+            name="profile_name",
+            kind="Text",
+            description="Unique name identifier for the profile",
+            min_length=3,
+            max_length=32,
+            unique=True,
+            optional=False,
+        ),
+        Attr(
+            name="profile_priority",
+            kind="Number",
+            description="Priority level for profile application (lower numbers have higher priority)",
+            default_value=1000,
+            optional=True,
+        ),
     ],
 )

infrahub/core/schema/definitions/core/propose_change.py

@@ -29,18 +29,38 @@ core_proposed_change = NodeSchema(
     attributes=[
         Attr(name="name", kind="Text", optional=False),
         Attr(name="description", kind="TextArea", optional=True),
-        Attr(name="source_branch", kind="Text", optional=False),
-        Attr(name="destination_branch", kind="Text", optional=False),
+        Attr(
+            name="source_branch", kind="Text", description="Name of the branch containing the changes", optional=False
+        ),
+        Attr(
+            name="destination_branch",
+            kind="Text",
+            description="Name of the branch to merge changes into",
+            optional=False,
+        ),
         Attr(
             name="state",
             kind="Text",
+            description="Current state of the proposed change",
             enum=ProposedChangeState.available_types(),
             default_value=ProposedChangeState.OPEN.value,
             optional=True,
         ),
-        Attr(name="is_draft", kind="Boolean", optional=False, default_value=False),
+        Attr(
+            name="is_draft",
+            kind="Boolean",
+            description="Whether the proposed change is still a draft",
+            optional=False,
+            default_value=False,
+        ),
         # Ideally we should support some "runtime-attribute" that could not even be stored in the database.
-        Attr(name="total_comments", kind="Number", optional=True, read_only=True),
+        Attr(
+            name="total_comments",
+            kind="Number",
+            description="Total number of comments on this proposed change",
+            optional=True,
+            read_only=True,
+        ),
     ],
     relationships=[
         Rel(

infrahub/core/schema/definitions/core/propose_change_comment.py

@@ -23,8 +23,8 @@ core_propose_change_comment = GenericSchema(
     include_in_menu=False,
     branch=BranchSupportType.AGNOSTIC,
     attributes=[
-        Attr(name="text", kind="TextArea", unique=False, optional=False),
-        Attr(name="created_at", kind="DateTime", optional=True),
+        Attr(name="text", kind="TextArea", description="Content of the comment", unique=False, optional=False),
+        Attr(name="created_at", kind="DateTime", description="Timestamp when the comment was created", optional=True),
     ],
     relationships=[
         Rel(
@@ -48,8 +48,13 @@ core_thread = GenericSchema(
     include_in_menu=False,
     attributes=[
         Attr(name="label", kind="Text", optional=True),
-        Attr(name="resolved", kind="Boolean", default_value=False),
-        Attr(name="created_at", kind="DateTime", optional=True),
+        Attr(
+            name="resolved",
+            kind="Boolean",
+            description="Whether the thread has been marked as resolved",
+            default_value=False,
+        ),
+        Attr(name="created_at", kind="DateTime", description="Timestamp when the thread was created", optional=True),
     ],
     relationships=[
         Rel(
@@ -101,9 +106,9 @@ core_file_thread = NodeSchema(
     inherit_from=[InfrahubKind.THREAD],
     generate_profile=False,
     attributes=[
-        Attr(name="file", kind="Text", optional=True),
-        Attr(name="commit", kind="Text", optional=True),
-        Attr(name="line_number", kind="Number", optional=True),
+        Attr(name="file", kind="Text", description="Path to the file being discussed", optional=True),
+        Attr(name="commit", kind="Text", description="Git commit hash the thread refers to", optional=True),
+        Attr(name="line_number", kind="Number", description="Line number in the file being discussed", optional=True),
     ],
     relationships=[
         Rel(
@@ -126,9 +131,16 @@ core_artifact_thread = NodeSchema(
     inherit_from=[InfrahubKind.THREAD],
     generate_profile=False,
     attributes=[
-        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="artifact_id",
+            kind="Text",
+            description="Unique identifier of the artifact being discussed",
+            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 in the artifact being discussed", optional=True
+        ),
     ],
 )
 
@@ -142,7 +154,7 @@ core_object_thread = NodeSchema(
     inherit_from=[InfrahubKind.THREAD],
     generate_profile=False,
     attributes=[
-        Attr(name="object_path", kind="Text", optional=False),
+        Attr(name="object_path", kind="Text", description="Path to the object being discussed", optional=False),
     ],
 )
 

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,
+        ),
     ],
 )