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

infrahub/core/schema/attribute_parameters.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import sys
-from typing import Self
+from typing import Any, Self
 
 from pydantic import ConfigDict, Field, model_validator
 
@@ -24,6 +24,33 @@ def get_attribute_parameters_class_for_kind(kind: str) -> type[AttributeParamete
 class AttributeParameters(HashableModel):
     model_config = ConfigDict(extra="forbid")
 
+    @classmethod
+    def convert_from(cls, source: AttributeParameters) -> Self:
+        """Convert from another AttributeParameters subclass.
+
+        Args:
+            source: The source AttributeParameters instance to convert from
+
+        Returns:
+            A new instance of the target class with compatible fields populated
+        """
+        source_data = source.model_dump()
+        return cls.convert_from_dict(source_data=source_data)
+
+    @classmethod
+    def convert_from_dict(cls, source_data: dict[str, Any]) -> Self:
+        """Convert from a dictionary to the target class.
+
+        Args:
+            source_data: The source dictionary to convert from
+
+        Returns:
+            A new instance of the target class with compatible fields populated
+        """
+        target_fields = set(cls.model_fields.keys())
+        filtered_data = {k: v for k, v in source_data.items() if k in target_fields}
+        return cls(**filtered_data)
+
 
 class TextAttributeParameters(AttributeParameters):
     regex: str | None = Field(

infrahub/core/schema/attribute_schema.py

@@ -70,7 +70,7 @@ class AttributeSchema(GeneratedAttributeSchema):
 
     @property
     def support_profiles(self) -> bool:
-        return self.read_only is False and self.optional is True
+        return self.read_only is False and self.unique is False
 
     def get_id(self) -> str:
         if self.id is None:
@@ -114,13 +114,20 @@ class AttributeSchema(GeneratedAttributeSchema):
     @field_validator("parameters", mode="before")
     @classmethod
     def set_parameters_type(cls, value: Any, info: ValidationInfo) -> Any:
-        """Override parameters class if using base AttributeParameters class and should be using a subclass"""
+        """Override parameters class if using base AttributeParameters class and should be using a subclass.
+
+        This validator handles parameter type conversion when an attribute's kind changes.
+        Fields from the source that don't exist in the target are silently dropped.
+        Fields with the same name in both classes are preserved.
+        """
         kind = info.data["kind"]
         expected_parameters_class = get_attribute_parameters_class_for_kind(kind=kind)
         if value is None:
             return expected_parameters_class()
         if not isinstance(value, expected_parameters_class) and isinstance(value, AttributeParameters):
-            return expected_parameters_class(**value.model_dump())
+            return expected_parameters_class.convert_from(value)
+        if isinstance(value, dict):
+            return expected_parameters_class.convert_from_dict(source_data=value)
         return value
 
     @model_validator(mode="after")
@@ -168,7 +175,7 @@ class AttributeSchema(GeneratedAttributeSchema):
 
     def update_from_generic(self, other: AttributeSchema) -> None:
         fields_to_exclude = ("id", "order_weight", "branch", "inherited")
-        for name in self.model_fields:
+        for name in self.__class__.model_fields:
             if name in fields_to_exclude:
                 continue
             if getattr(self, name) != getattr(other, name):
@@ -238,19 +245,6 @@ class TextAttributeSchema(AttributeSchema):
         json_schema_extra={"update": UpdateSupport.VALIDATE_CONSTRAINT.value},
     )
 
-    @model_validator(mode="after")
-    def reconcile_parameters(self) -> Self:
-        if self.regex != self.parameters.regex:
-            final_regex = self.parameters.regex if self.parameters.regex is not None else self.regex
-            self.regex = self.parameters.regex = final_regex
-        if self.min_length != self.parameters.min_length:
-            final_min_length = self.parameters.min_length if self.parameters.min_length is not None else self.min_length
-            self.min_length = self.parameters.min_length = final_min_length
-        if self.max_length != self.parameters.max_length:
-            final_max_length = self.parameters.max_length if self.parameters.max_length is not None else self.max_length
-            self.max_length = self.parameters.max_length = final_max_length
-        return self
-
     def get_regex(self) -> str | None:
         return self.parameters.regex
 

infrahub/core/schema/basenode_schema.py

@@ -263,6 +263,9 @@ class BaseNodeSchema(GeneratedBaseNodeSchema):
     ) -> AttributeSchema | RelationshipSchema | None: ...
 
     def get_field(self, name: str, raise_on_error: bool = True) -> AttributeSchema | RelationshipSchema | None:
+        if name in NODE_PROPERTY_ATTRIBUTES:
+            return self.get_attribute(name=name)
+
         if field := self.get_attribute_or_none(name=name):
             return field
 

infrahub/core/schema/definitions/core/__init__.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, TypedDict
 
 from infrahub.actions.schema import (
     core_action,
@@ -93,7 +93,13 @@ from .template import core_object_component_template, core_object_template
 from .transform import core_transform, core_transform_jinja2, core_transform_python
 from .webhook import core_custom_webhook, core_standard_webhook, core_webhook
 
-core_models_mixed: dict[str, list] = {
+
+class CoreModelsMixedType(TypedDict):
+    generics: list[GenericSchema]
+    nodes: list[NodeSchema]
+
+
+core_models_mixed: CoreModelsMixedType = {
     "generics": [
         core_action,
         core_trigger_rule,

infrahub/core/schema/definitions/core/account.py

@@ -43,8 +43,8 @@ core_account_token = NodeSchema(
     documentation="/topics/auth",
     attributes=[
         Attr(name="name", kind="Text", optional=True),
-        Attr(name="token", kind="Text", unique=True),
-        Attr(name="expiration", kind="DateTime", optional=True),
+        Attr(name="token", kind="Text", description="The authentication token value", unique=True),
+        Attr(name="expiration", kind="DateTime", description="Date and time when the token expires", optional=True),
     ],
     relationships=[
         Rel(
@@ -68,13 +68,7 @@ core_password_credential = NodeSchema(
     inherit_from=[InfrahubKind.CREDENTIAL],
     attributes=[
         Attr(name="username", kind="Text", optional=True, branch=BranchSupportType.AGNOSTIC, order_weight=6000),
-        Attr(
-            name="password",
-            kind="Password",
-            optional=True,
-            branch=BranchSupportType.AGNOSTIC,
-            order_weight=7000,
-        ),
+        Attr(name="password", kind="Password", optional=True, branch=BranchSupportType.AGNOSTIC, order_weight=7000),
     ],
 )
 
@@ -88,7 +82,12 @@ core_refresh_token = NodeSchema(
     generate_profile=False,
     branch=BranchSupportType.AGNOSTIC,
     attributes=[
-        Attr(name="expiration", kind="DateTime", optional=False),
+        Attr(
+            name="expiration",
+            kind="DateTime",
+            description="Date and time when the refresh token expires",
+            optional=False,
+        ),
     ],
     relationships=[
         Rel(
@@ -144,6 +143,7 @@ core_generic_account = GenericSchema(
         Attr(
             name="account_type",
             kind="Text",
+            description="Type of account (user, script, etc.)",
             default_value=AccountType.USER.value,
             enum=AccountType.available_types(),
         ),

infrahub/core/schema/definitions/core/artifact.py

@@ -35,6 +35,7 @@ core_artifact_target = GenericSchema(
 core_artifact = NodeSchema(
     name="Artifact",
     namespace="Core",
+    description="A file generated by a transformation, associated with a specific object",
     label="Artifact",
     include_in_menu=False,
     icon="mdi:file-document-outline",
@@ -47,19 +48,17 @@ core_artifact = NodeSchema(
     documentation="/topics/artifact",
     attributes=[
         Attr(name="name", kind="Text"),
-        Attr(
-            name="status",
-            kind="Text",
-            enum=ArtifactStatus.available_types(),
-        ),
+        Attr(name="status", kind="Text", enum=ArtifactStatus.available_types()),
         Attr(
             name="content_type",
             kind="Text",
+            description="MIME type of the artifact content",
             enum=ContentType.available_types(),
         ),
         Attr(
             name="checksum",
             kind="Text",
+            description="Hash checksum of the artifact content for integrity verification",
             optional=True,
         ),
         Attr(
@@ -71,6 +70,7 @@ core_artifact = NodeSchema(
         Attr(
             name="parameters",
             kind="JSON",
+            description="Input parameters used to generate this artifact",
             optional=True,
         ),
     ],
@@ -97,6 +97,7 @@ core_artifact = NodeSchema(
 core_artifact_definition = NodeSchema(
     name="ArtifactDefinition",
     namespace="Core",
+    description="Defines how artifacts are generated from a transformation for a group of targets",
     include_in_menu=False,
     icon="mdi:file-document-multiple-outline",
     label="Artifact Definition",
@@ -110,10 +111,15 @@ core_artifact_definition = NodeSchema(
     documentation="/topics/artifact",
     attributes=[
         Attr(name="name", kind="Text", unique=True),
-        Attr(name="artifact_name", kind="Text"),
+        Attr(name="artifact_name", kind="Text", description="Name template for generated artifacts"),
         Attr(name="description", kind="Text", optional=True),
-        Attr(name="parameters", kind="JSON"),
-        Attr(name="content_type", kind="Text", enum=ContentType.available_types()),
+        Attr(name="parameters", kind="JSON", description="GraphQL query parameters for the transformation"),
+        Attr(
+            name="content_type",
+            kind="Text",
+            description="MIME type of the generated artifacts",
+            enum=ContentType.available_types(),
+        ),
     ],
     relationships=[
         Rel(

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(