darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-08-25 00:33:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

Last bit of formatting improvements.

Browse Source 
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
Carlo Costino
2023-07-05 15:34:30 -04:00
parent f93972e9c4
commit 34cd616cac
1 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/adrs/0005-agreement-data-model.md
View File

@@ -8,7 +8,10 @@
## CONTEXT AND PROBLEM STATEMENT ## CONTEXT AND PROBLEM STATEMENT
**OPEN ISSUE(S):** https://github.com/GSA/notifications-api/issues/141, https://github.com/GSA/notifications-admin/issues/53, https://github.com/GSA/notifications-admin/issues/51 **OPEN ISSUE(S):**
* https://github.com/GSA/notifications-api/issues/141
* https://github.com/GSA/notifications-admin/issues/53
* https://github.com/GSA/notifications-admin/issues/51
We will be entering into Memoranda of Understanding (MOU) and Interagency We will be entering into Memoranda of Understanding (MOU) and Interagency
Agreements (IAA) with partner agencies. Data from those agreements will be Agreements (IAA) with partner agencies. Data from those agreements will be
@@ -118,15 +121,15 @@ This process includes adding the new model and updating the existing models to
use them. use them.
1. Add the new model: 1. Add the new model:
- Add Agreement to models.py with the fields identified above - Add Agreement to models.py with the fields identified above
- Create migration to add/update table - Create migration to add/update table
2. Update the Organisation model: 2. Update the Organisation model:
- Add one-to-many field linking one Organisation to multiple Agreements - Add one-to-many field linking one Organisation to multiple Agreements
- Add model property to convert budget amount into message limit - Add model property to convert budget amount into message limit
- Add model property to provide remaining budget based on sent messages - Add model property to provide remaining budget based on sent messages
- Add model property about whether free tier or not - Add model property about whether free tier or not
- Add model property for free tier usage (retrieve messages sent in a year) - Add model property for free tier usage (retrieve messages sent in a year)
This will set up a new system, but stops short of connecting agreements to the This will set up a new system, but stops short of connecting agreements to the
services actually sending the messages. This approach will be laid out in a services actually sending the messages. This approach will be laid out in a