darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-23 17:01:35 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #674 from GSA/673-data-dictionary

Browse Source 
673 data dictionary
This commit is contained in:
Carlo Costino
2024-03-25 11:12:46 -04:00
committed by GitHub
parent 0930b593ab 232bbd2d8a
commit b3b7e94c14
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/data-dictionary.md Normal file
View File

@@ -0,0 +1,17 @@
# notify.gov Data Dictionary
This document serves as a comprehensive guide to the data structure of notify.gov. It outlines the key data elements, their types, and relationships within the system. From user information to message details, this data dictionary is a valuable resource for understanding and maintaining the underlying data model of this application. Use this guide to ensure consistency, clarity, and effective management of the data that powers our messaging functionality.
# Table: Global
| Field | Type | Length | Description |
|-------------------------------------|-----------|--------|------------------------------------------------------------------|
| service_id | Integer | | Service ID - reference for most data related to a service |
## Table: Dashboard
| Field | Type | Length | Description |
|-------------------------------------|-----------|--------|--------------------------------------------|
| global_message_limit | Integer | | Message limit set by platform admin |
| daily_global_messages_remaining | Integer | | Remaining messages in database |