docs: add database design document

[ghost]

API PR Checklist

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary testing using the test suite to ensure that any existing features are not impacted and any new features are working as expected.
• I have updated the required api docs as applicable.
• I have added/updated test cases to the test suite as applicable

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Query request and response examples have been added (as applicable, in case added or updated)
• Documentation changes have been listed (as applicable)
• Test suite output is added (as applicable)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:
This PR adds database design documentation for the app.

Related changes:
Mentioned in Documentation changes

Screenshots:
N/A

Query request and response:
N/A

Documentation changes:

• Add database-design.md with database schema section give overview of the tables, data dictionary section explaining the different properties in the tables
• Add the database er diagram image and file to assets
• Update api readme to include link to the database design doc

Test suite output:
N/A

Pending actions:
N/A

Additional notes:
N/A

Summary by CodeRabbit

• Documentation
  • Added a "Database Design" section in the API documentation, including a detailed overview and a visual ERD diagram of the database schema with two tables.

[coderabbitai]

Walkthrough

The recent update introduces a comprehensive section on "Database Design" within the API documentation for the OsmoX application. This addition encompasses a detailed overview of the database schema, focusing on two main tables—notify_migrations and notify_notifications. It also includes a visual ERD diagram to aid in understanding the database structure, enhancing the documentation's clarity and utility for developers working with OsmoX.

Changes

File Path	Change Summary
apps/api/README.md	Added a section on "Database Design"
apps/api/docs/database-design.md apps/api/docs/assets/OsmoX_database_schema.erd	Introduced a detailed overview of the database design for OsmoX, including a schema with tables and an ERD diagram

🐇✨
In the realm of code, where data intertwines,
A rabbit hopped in, leaving marks behind.
Tables and diagrams, in documents they bind,
A design so fine, it's one of a kind.
🌟📚

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c77fa4b and 8aedf1e.

Files ignored due to path filters (1)

• apps/api/docs/assets/OsmoX_database_schema.png is excluded by: !**/*.png

Files selected for processing (3)

• apps/api/README.md (1 hunks)
• apps/api/docs/assets/OsmoX_database_schema.erd (1 hunks)
• apps/api/docs/database-design.md (1 hunks)

Files skipped from review due to trivial changes (1)

• apps/api/docs/assets/OsmoX_database_schema.erd

Additional comments: 3

apps/api/README.md (1)

• 38-38: Ensure the link to database-design.md is functional and correctly leads to the new database design document.

apps/api/docs/database-design.md (2)

• 1-45: The document structure and content are well-organized, providing a clear overview of the database schema. However, ensure that the links to the assets (OsmoX_database_schema.png and OsmoX_database_schema.erd) are functional and that the assets are correctly placed in the repository.
• 24-45: The data dictionary is comprehensive and clearly outlines the attributes for each table. Ensure that the data types and constraints match the actual database schema and that the links to other documentation sections (e.g., Available Channel Types, Delivery Status Information) are accurate and functional.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8aedf1e and 019f408.

Files selected for processing (1)

• apps/api/README.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• apps/api/README.md