Sequence Diagrams
Simplified sequence diagrams showing the essential interactions between components for the Connector module. These diagrams illustrate the chronological flow of operations and message exchanges between different components in the system.
Diagrams
sequence-connector-connect.md - Connect connector endpoint
Shows flow from Client → BE Smart Search → BOSA
Includes authentication and BOSA credential preparation
Demonstrates integration check and OAuth URL return for setup
sequence-connector-disconnect.md - Disconnect connector endpoint
Shows flow from Client → BE Smart Search → BOSA
Includes authentication and BOSA credential preparation
Demonstrates integration removal and error handling
sequence-connector-search.md - Search connector endpoint
Shows flow from Client → BE Smart Search → AIP Agent Service → BOSA
Includes authentication, integration check, and query execution
Demonstrates search result processing and streaming support
Usage
These diagrams can be viewed:
In any Markdown viewer that supports Mermaid (GitHub, GitLab, etc.)
In VS Code with the Mermaid extension
Online at https://mermaid.live/
In documentation tools like MkDocs, Docusaurus, etc.
Updating Diagrams
When updating the codebase, please update the relevant diagrams to reflect architectural changes. The diagrams should be kept in sync with the implementation.
Last updated