docs: update block diagram

[kshitij-k-osmosys]

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 unit testing for the new feature added or updated to ensure the new features added are working as expected.
• I have added/updated test cases to the test suite as applicable.
• 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 as a whole.
• I have added/updated the required api docs as applicable.
• I have added/updated the .env.example file with the required values 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/unit testing 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)

Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass.

---

Description:

Update block diagram for OsmoX

Related changes:
NA

Screenshots:
NA

Query request and response:
NA

Documentation changes:
NA

Test suite/unit testing output:
NA

Pending actions:
NA

Additional notes:
NA

Summary by CodeRabbit

Summary by CodeRabbit

• New Features
  • Enhanced the OsmoX block diagram with new components for improved clarity, including cells for "UserObject," "Recipient(s)," "Scheduler Endpoint," and various notification processes.
  • Introduced new services like "Mailgun" and "Twilio" within the diagram.
• Improvements
  • Updated layout and connections between elements for better visual flow and understanding of system interactions.

[coderabbitai]

Walkthrough

The pull request introduces substantial modifications to the OsmoX-block-diagram.drawio file. It involves the addition, removal, and modification of various graphical elements, including new cells representing processes, queues, and notifications. The layout has been restructured to improve clarity, with updated connections reflecting changes in component interactions. New labels and images have been incorporated for services such as "Mailgun" and "Twilio," contributing to a comprehensive update of the system's visual representation.

Changes

File	Change Summary
apps/api/docs/assets/OsmoX-block-diagram.drawio	Significant restructuring of graphical elements, including the addition of multiple new cells representing various processes and services.

Poem

In the meadow where diagrams play,
New cells hop in, brightening the day.
Twilio and Mailgun join the fun,
With processes dancing, one by one.
Clarity blooms in the visual flow,
A rabbit's delight in the changes we sow! 🐇✨

---

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>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

Outside diff range and nitpick comments (3)

apps/api/docs/assets/OsmoX-block-diagram.drawio (3)

10-14: Clarify the label value in UserObject.

At line 10, the UserObject element has a label set to a backtick "`". This might be unintentional or a placeholder. Consider providing a meaningful label to improve the clarity of the diagram.

---

54-55: Remove redundant mxPoint elements.

Lines 54-55 contain two identical mxPoint elements with x="80" and y="-380". This duplication may be unnecessary and could be removed to simplify the diagram.

---

278-280: Consistent labeling of recipient nodes.

In line 278, the mxCell with id="L9cUNZ-uKrun5VPk3kAT-68" has the value "Pending Notification sent within retry limit". Ensure that this label is consistent with similar nodes in the diagram for clarity.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e531301 and fde3f05.

Files ignored due to path filters (1)

• apps/api/docs/assets/OsmoX-block-diagram.png is excluded by !**/*.png

Files selected for processing (1)

• apps/api/docs/assets/OsmoX-block-diagram.drawio (1 hunks)

Additional comments not posted (2)

apps/api/docs/assets/OsmoX-block-diagram.drawio (2)

364-366: Ensure the accuracy of the label "Request via Webhook Link".

At line 364, the mxCell has the value "Request via Webhook Link". Confirm that this label accurately represents the underlying process or data flow in the diagram.

---

81-82: Specify the x attribute in mxGeometry.

At line 81, the mxGeometry element lacks an x attribute:

<mxGeometry y="-355" width="100" height="30" as="geometry" />

Consider adding the x attribute to explicitly define the horizontal position.

Run the following script to check for any mxGeometry elements missing the x attribute:

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fde3f05 and 01edd00.

🔇 Files ignored due to path filters (1)

• apps/api/docs/assets/OsmoX-block-diagram.png is excluded by !**/*.png

📒 Files selected for processing (1)

• apps/api/docs/assets/OsmoX-block-diagram.drawio (1 hunks)

🔇 Additional comments not posted (4)

apps/api/docs/assets/OsmoX-block-diagram.drawio (4)

15-15: Duplicate Comment: Correct the HTML entity encoding in the value attribute

The previous comment about correcting the HTML entity encoding in the value attribute still applies.

---

335-335: Duplicate Comment: Update the image URL for Twilio logo

The previous comment about updating the image URL for the Twilio logo still applies.

---

115-115: ⚠️ Potential issue

Correct the HTML entity encoding in the value attribute

In the value attribute, & is used, which will render incorrectly. Replace & with & to correctly display an ampersand.

Apply this diff:

-value="Scheduler Script to trigger Pending Notifications & Awaiting confirmation Notifications"
+value="Scheduler Script to trigger Pending Notifications & Awaiting confirmation Notifications"

Likely invalid or redundant comment.

---

30-31: Verify all external image URLs are hosted reliably

To ensure that all images in the diagram remain accessible over time, please verify that external image URLs are stable and consider hosting them locally.

Run the following script to list all external image URLs used in the diagram:

Also applies to: 48-49, 335-335