PROD-2058 implement endpoints for property specific messaging

[eastandwestwind]

Closes https://ethyca.atlassian.net/browse/PROD-2058

Description Of Changes

Implements API endpoints for property-specific messaging. The following new endpoints were added:

• GET /messaging/templates/summary- get paginated list of all templates
• GET /messaging/templates/default/{template_type}- get the default messaging template by type. This is not dependent on the DB at all, rather hard-coded in the BE.
• POST /messaging/templates/{template_type}- create a new messaging template . Use req body formatted like:

content: Dict[str, Any]
properties: Optional[List[str]]
is_enabled: bool

• PUT /messaging/templates/{id}- update an existing messaging template. Use req body formatted like:

content: Dict[str, Any]
properties: Optional[List[str]]
is_enabled: bool

• PATCH /messaging/templates/{id}- update an existing messaging template. Use req body formatted like:

content: Optional[Dict[str, Any]]
properties: Optional[List[str]]
is_enabled: Optional[bool]

• GET /messaging/templates/{id}- get an existing messaging template by id
• DELETE /messaging/templates/{id} - delete a messaging template by id

Code Changes

• Adds new endpoints to support property-specific messaging
• Adds endpoint tests

Steps to Confirm

• Attempt to add / edit / create /delete messaging templates via endpoints. See endpoint tests in ops/api/v1/endpoints/test_messaging_endpoints.py for details of how the endpoints should function.

Pre-Merge Checklist

• All CI Pipelines Succeeded
• Documentation:
  • documentation complete, PR opened in fidesdocs
  • documentation issue created in fidesdocs
  • if there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
• Issue Requirements are Met
• Relevant Follow-Up Issues Created
• Update CHANGELOG.md
• For API changes, the Postman collection has been updated
• If there are any 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
    • If a downgrade migration is not possible for this change, please call this out in the PR description!

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
fides-plus-nightly	⬜️ Ignored (Inspect)	Visit Preview		Jun 18, 2024 11:03am

[cypress]

Passing run #8366 ↗︎

0	4	0	0	0
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.

Details:

Merge dfa3ae6 into 29305c1...
Project: fides	Commit: 1f377f4b18 ℹ️
Status: Passed	Duration: 00:35 💡
Started: Jun 18, 2024 11:15 AM	Ended: Jun 18, 2024 11:15 AM

Review all test suite changes for PR #4983 ↗︎

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.59%. Comparing base (29305c1) to head (dfa3ae6).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4983      +/-   ##
==========================================
+ Coverage   86.54%   86.59%   +0.04%     
==========================================
  Files         351      351              
  Lines       21739    21818      +79     
  Branches     2878     2881       +3     
==========================================
+ Hits        18814    18893      +79     
  Misses       2420     2420              
  Partials      505      505              

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

[eastandwestwind]

Pipeline failures dependent on #4993 being merged

[galvana]

Very straightforward set of endpoints to manage all of these templates! Everything worked as expected so feel free to address my comments only if time permits. The two things that stuck out to me were:

• Having these endpoints in fides, in my opinion, since they are for plus functionality, the endpoints should be defined in fidesplus
• Using a more constrained enum instead of MessagingActionType for the GET/POST /api/v1/messaging/templates/{template_type} endpoints

[eastandwestwind]

Ticket to move endpoints to plus as a follow-up: https://ethyca.atlassian.net/browse/PROD-2211

[cypress]

Passing run #8367 ↗︎

0	4	0	0	0
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.

Details:

PROD-2058 implement endpoints for property specific messaging (#4983)
Project: fides	Commit: c2bfdbe899
Status: Passed	Duration: 00:34 💡
Started: Jun 18, 2024 12:28 PM	Ended: Jun 18, 2024 12:29 PM

Review all test suite changes for PR #4983 ↗︎