Flow Diagrams

Simplified flowcharts showing decision flows and process steps for each endpoint in the Connector module. These diagrams illustrate the logical flow, decision points, and error handling paths for each operation.

Diagrams

  1. flow-connector-connect.md - Connect connector flow

    • Complete flow: Authentication → Prepare BOSA Credentials → Check Integration → Return OAuth URL or Connected Status

    • Shows BOSA credential preparation (internal vs custom token)

    • Demonstrates integration check and OAuth setup process

  2. flow-connector-disconnect.md - Disconnect connector flow

    • Complete flow: Authentication → Prepare BOSA Credentials → Remove Integration → Return Status

    • Shows BOSA credential preparation

    • Demonstrates integration removal and error handling

  3. flow-connector-search.md - Search connector flow

    • Complete flow: Authentication → Prepare BOSA Credentials → Check Integration → Execute Query or Return OAuth URL

    • Shows integration check before query execution

    • Demonstrates AIP agent query execution via BOSA

    • Shows WebSocket event streaming for real-time updates

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