ENG-3118: Add user_assigned_description column to StagedResource

[dsill-ethyca]

Ticket ENG-3118

Description Of Changes

Adds a nullable user_assigned_description column to the stagedresource table. This enables the frontend to distinguish system-generated descriptions (show sparkle icon) from user-edited descriptions (no sparkle) for IDP monitor resources.

Follows the same pattern as user_assigned_data_uses — nullable column where NULL means system-generated and non-null means user override.

Note: This PR contains only the fides (OSS) model + migration change. The fidesplus PR with schema, service, and test changes will follow and depend on this one.

Code Changes

• Added user_assigned_description column to StagedResource DB model (core.py)
• Added alembic migration 6a42f48c23dd to create the column

Steps to Confirm

1. Run alembic upgrade head — verify user_assigned_description column exists on stagedresource table
2. Run alembic downgrade -1 — verify column is dropped cleanly
3. Verify no multiple-head issues: alembic heads returns a single head

Pre-Merge Checklist

• Issue requirements met
• All CI pipelines succeeded
• CHANGELOG.md updated
  • Add a db-migration label to the entry if your change includes a DB migration
  • Add a high-risk label to the entry if your change includes a high-risk change
  • Updates unreleased work already in Changelog, no new entry necessary
• UX feedback:
  • No UX review needed
• Followup issues:
  • No followup issues
• Database migrations:
  • Ensure that your downrev is up to date with the latest revision on main
  • Ensure that your downgrade() migration is correct and works
• Documentation:
  • No documentation updates required

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
fides-plus-nightly	Ignored	Preview	Apr 7, 2026 8:09pm
fides-privacy-center	Ignored		Apr 7, 2026 8:09pm

[claude]

Code Review

Clean, minimal PR that does exactly what it says. The migration chain is valid, the column definition is consistent with how other user_assigned_* fields are modelled, and the changelog entry correctly carries the db-migration label.

One suggestion worth considering:

The user_assigned_data_uses column has a prose comment explaining its nullable semantics (see lines 581–584 of core.py). This user_assigned_description column carries the same kind of meaningful nullable contract (NULL = system-generated, non-null = user override), so a matching comment would improve long-term maintainability. See the inline note on core.py.

Everything else looks good:

• down_revision correctly targets d4e5f6a7b8c9 (the password-reset-flow migration, the current head on main)
• downgrade() is correct — mirrors the upgrade() exactly
• db_dataset.yml updated to include the new column
• No schema/API layer changes are expected in this PR per the description; those follow in the dependent fidesplus PR

No blockers — happy to approve once the comment thread is addressed (or acknowledged as intentionally omitted).

[claude]

Consider adding an explanatory comment matching the pattern established by user_assigned_data_uses above. Since the nullable semantics here carry meaningful business logic (NULL = system-generated description, non-null = user override), a comment would help future readers:

# This field is intentionally nullable to distinguish system-generated descriptions
# (value is None) from user-edited descriptions (non-null value). This enables the
# frontend to show a sparkle icon only for system-generated descriptions.
user_assigned_description = Column(String, nullable=True)

Also a minor nit: the sibling columns user_assigned_data_uses uses default=None explicitly. If you want consistency, you could add default=None here too — though it's not a correctness issue since SQLAlchemy implicitly treats nullable columns as None.

[dsill-ethyca]

Added the explanatory comment. Intentionally omitted default=None as it's redundant for nullable String columns — user_assigned_data_uses includes it because of ARRAY-specific empty-vs-null semantics that don't apply here.

[claude]

Confirmed: d4e5f6a7b8c9 is the revision ID of xx_2026_04_03_1000_d4e5f6a7b8c9_add_password_reset_flow.py, so the migration chain is correct. The checklist item ✅ holds.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.07%. Comparing base (10d9fc7) to head (8a99821).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7847   +/-   ##
=======================================
  Coverage   85.06%   85.07%           
=======================================
  Files         627      627           
  Lines       40765    40766    +1     
  Branches     4740     4740           
=======================================
+ Hits        34678    34680    +2     
+ Misses       5018     5017    -1     
  Partials     1069     1069           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[adamsachs]

👍