Merge pull request #906 from atlanhq/GOV-778

GOV-778 fix(typedef) | add show_as_featured to AttributeDef.Options to prevent silent data loss on update

Author: Aryamanz29

pyatlan/model/typedef.py

@@ -551,6 +551,10 @@ class Options(AtlanObject):
             default=False,
             description="Whether this attribute supports rich text formatting (True) or not (False). ",
         )
+        show_as_featured: Optional[bool] = Field(
+            default=None,
+            description="Whether this attribute is shown as featured in the asset profile (True) or not (False).",
+        )
 
         def __setattr__(self, name, value):
             super().__setattr__(name, value)

pyatlan_v9/model/typedef.py

@@ -553,6 +553,9 @@ class Options(msgspec.Struct, kw_only=True, rename="camel", omit_defaults=True):
         is_rich_text: Union[bool, None, msgspec.UnsetType] = msgspec.UNSET
         """Whether this attribute supports rich text formatting."""
 
+        show_as_featured: Union[bool, None, msgspec.UnsetType] = msgspec.UNSET
+        """Whether this attribute is shown as featured in the asset profile."""
+
         def __post_init__(self) -> None:
             if self.custom_metadata_version is msgspec.UNSET:
                 self.custom_metadata_version = "v2"

tests/integration/custom_metadata_test.py

@@ -340,6 +340,30 @@ def test_cm_raci(
     assert not one.options.multi_value_select
 
 
+@pytest.mark.order(after="test_cm_raci")
+def test_show_as_featured_survives_update(
+    client: AtlanClient, cm_raci: CustomMetadataDef
+):
+    existing = client.custom_metadata_cache.get_custom_metadata_def(name=CM_RACI)
+    assert existing.attribute_defs
+    attr = existing.attribute_defs[0]
+    assert attr.options
+    attr.options.show_as_featured = True
+    assert existing.options
+    existing.options.is_locked = True
+    response = client.typedef.update(existing)
+    assert response
+    assert len(response.custom_metadata_defs) == 1
+    updated = response.custom_metadata_defs[0]
+    assert updated.attribute_defs
+    updated_attr = updated.attribute_defs[0]
+    assert updated_attr.options
+    assert updated_attr.options.show_as_featured is True
+    assert updated.options
+    updated.options.is_locked = False
+    client.typedef.update(updated)
+
+
 @pytest.fixture(scope="module")
 def cm_enum(
     client: AtlanClient,

tests_v9/integration/custom_metadata_test.py

@@ -340,6 +340,30 @@ def test_cm_raci(
     assert not one.options.multi_value_select
 
 
+@pytest.mark.order(after="test_cm_raci")
+def test_show_as_featured_survives_update(
+    client: AtlanClient, cm_raci: CustomMetadataDef
+):
+    existing = client.custom_metadata_cache.get_custom_metadata_def(name=CM_RACI)
+    assert existing.attribute_defs
+    attr = existing.attribute_defs[0]
+    assert attr.options
+    attr.options.show_as_featured = True
+    assert existing.options
+    existing.options.is_locked = True
+    response = client.typedef.updater(existing)
+    assert response
+    assert len(response.custom_metadata_defs) == 1
+    updated = response.custom_metadata_defs[0]
+    assert updated.attribute_defs
+    updated_attr = updated.attribute_defs[0]
+    assert updated_attr.options
+    assert updated_attr.options.show_as_featured is True
+    assert updated.options
+    updated.options.is_locked = False
+    client.typedef.updater(updated)
+
+
 @pytest.fixture(scope="module")
 def cm_enum(
     client: AtlanClient,