cds-snc / notification-planning

Project planning for GC Notify Team
4 stars 0 forks source link

Update documentation around variables to clarify that every row needs a value for each variable #1626

Open yaelberger-commits opened 1 month ago

yaelberger-commits commented 1 month ago

Description

As a (user), I need to understand that I can't leave a variable value empty in my spreadsheet or through the API so that I can avoid sending errors if I were to leave a variable empty.

WHY are we building? https://cds-snc.freshdesk.com/a/tickets/18429 A client ran into an error when trying to send a message with an empty value for a variable in their template WHAT are we building? A content update to our documentation for variables (API and UI) VALUE created by our solution Users won't run into errors/friction when trying to send

Other ideas out of scope: Allow optional variables. This is currently not possible and not on our roadmap at this time

Documentation and Artifacts

Good docs, figma mockups, ADRs, screenshots etc.

Acceptance Criteria

Given a Sender is sending a message using a template with a variable, when they fill in their spreadsheet or populate their variables using the API, then they know in advance that there must be a value for every variable for each message and that they can't leave a variable value empty.

Related Research Airtable records

QA Steps

GC Articles Publish checklist

yaelberger-commits commented 1 month ago

Hey team! Please add your planning poker estimate with Zenhub @amazingphilippe @YedidaZalik