GOV-778 fix(typedef) | add show_as_featured to AttributeDef.Options to prevent silent data loss on update#906
Merged
Merged
Conversation
Aryamanz29
requested changes
Apr 21, 2026
Member
Aryamanz29
left a comment
There was a problem hiding this comment.
LGTM! One minor request:
Could you please add/update the integration tests (for both pyatlan and pyatlan_v9) to use this property and validate it properly gets assigned to the CM attribute? 🙏
Aryamanz29
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✨ Description
Problem
When updating a Custom Metadata typedef via the SDK (e.g. setting
cm.options.is_locked = Truethen calling
typedef.update(cm)), theshowAsFeaturedsetting on attribute definitions wassilently cleared in the backend.
Root Cause
AttributeDef.Optionsdid not model theshowAsFeaturedfield. BecauseAtlanObjectusesConfig.extra = Extra.ignore, Pydantic silently discards unknown fields on parse. This meant:attributeDefs[*].options.showAsFeatured: trueAttributeDef.Options→ field unknown → droppedtypedef.update()serializes the full CM (including attributeDefs) →showAsFeaturedabsent in payloadFix
Add
show_as_featured: Optional[bool]toAttributeDef.Options. Thealias_generator = to_camel_caseon
AtlanObjectautomatically maps this toshowAsFeaturedin API JSON, so the field nowround-trips correctly through fetch → modify → update.
Impact
Any SDK operation that fetched and re-submitted a CM typedef with
showAsFeaturedset on anyattribute was silently clearing that setting. No other attribute option fields are affected.
Jira link: [IGOV-778]
🧩 Type of change
Select all that apply:
✅ How has this been tested? (e.g. screenshots, logs, workflow links)
Describe how the change was tested. Include:
📋 Checklist