Skip to content

Commit

Permalink
docs: fix table
Browse files Browse the repository at this point in the history
  • Loading branch information
@kshitij-k-osmosys
kshitij-k-osmosys committed Nov 29, 2024
1 parent 50cb834 commit eafb59a
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions apps/api/docs/database-design.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@ The ERD diagram file for this schema can be accessed [here](./assets/OsmoX_datab

### notify_archived_notifications

| Attribute | Data Type | Not Null | Default | Description |
| --------------- | ------------ | -------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | int(11) | True | | Primary key, stores the id value for different archived notifications |
| notification_id | int(11) | True | Stores the original id value of the notification | |
| channel_type | tinyint(4) | True | | Foreign Key. Identifier for related master_provider. Stores the channel type used for the notification. Can be a value from [Available Channel Types](./usage-guide.md#5-available-channel-types) |
| data | text | True | | Stores JSON data about the notification such as the from/to addresses, subject and body content |
| delivery_status | tinyint(4) | True | 1 | Stores the current delivery status of the notification. Can be a value from [Delivery Status Information](./usage-guide.md#6-delivery-status-information) |
| result | text | False | NULL | Stores the JSON result after attempting to send the notification |
| created_on | timestamp | True | current_timestamp() | Stores the timestamp for the creation of the notification |
| updated_on | timestamp | True | current_timestamp() | Stores the timestamp for the last update to the notification |
| created_by | varchar(255) | True | | Stores the name of the service/app that created the notification |
| updated_by | varchar(255) | True | | Stores the name of the service/app that last updated the notification |
| status | tinyint(4) | True | 1 | Stores whether the notification must be considered as active(1) or inactive(0) |
| application_id | int(11) | False | NULL | Stores the id value for related application_id |
| provider_id | int(11) | False | NULL | Foreign key. Identifier for related provider. Stores the id value for related active provider |
| retry_count | int(3) | True | 0 | Identifies the retry count for the notification |
| Attribute | Data Type | Not Null | Default | Description |
| --------------- | ------------ | -------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | int(11) | True | | Primary key, stores the id value for different archived notifications |
| notification_id | int(11) | True | | Indexed. Stores the original id value of the notification |
| channel_type | tinyint(4) | True | | Foreign Key. Identifier for related master_provider. Stores the channel type used for the notification. Can be a value from [Available Channel Types](./usage-guide.md#5-available-channel-types) |
| data | text | True | | Stores JSON data about the notification such as the from/to addresses, subject and body content |
| delivery_status | tinyint(4) | True | 1 | Indexed. Stores the current delivery status of the notification. Can be a value from [Delivery Status Information](./usage-guide.md#6-delivery-status-information) |
| result | text | False | NULL | Stores the JSON result after attempting to send the notification |
| created_on | timestamp | True | current_timestamp() | Stores the timestamp for the creation of the notification |
| updated_on | timestamp | True | current_timestamp() | Stores the timestamp for the last update to the notification |
| created_by | varchar(255) | True | | Stores the name of the service/app that created the notification |
| updated_by | varchar(255) | True | | Stores the name of the service/app that last updated the notification |
| status | tinyint(4) | True | 1 | Stores whether the notification must be considered as active(1) or inactive(0) |
| application_id | int(11) | False | NULL | Stores the id value for related application_id |
| provider_id | int(11) | False | NULL | Foreign key. Identifier for related provider. Stores the id value for related active provider |
| retry_count | int(3) | True | 0 | Identifies the retry count for the notification |

### notify_master_providers

Expand Down

0 comments on commit eafb59a

Please sign in to comment.