architecture-as-code icon indicating copy to clipboard operation
architecture-as-code copied to clipboard

Enhancement: Improve Flow Sequence Diagram Generation Using Full CALM Model

Open LeighFinegold opened this issue 1 year ago • 0 comments

Summary

Currently, flow sequence diagram generation in CALM relies only on relationship names, limiting the depth and accuracy of the diagrams. With the recent support for dereferencing the full CALM model (#1026), it is now possible to extract richer details for sequence diagrams.

Proposed Changes

  1. Leverage the Fully Dereferenced Model:

    • Extract source, target, interaction details, and metadata from the fully dereferenced model instead of relying on relationship names.
    • Ensure that all necessary properties (e.g., actionType, protocol, messageFormat) are available for generating diagrams.
  2. Enhance Diagram Labeling & Formatting:

    • Improve labeling by including interaction types, protocols, and message details.
    • Ensure generated diagrams provide better clarity and meaningful representations.
  3. Maintain Backward Compatibility:

    • Ensure that existing diagrams using relationship names continue to function as expected.
    • Provide a fallback mode if full dereferencing is not available.

Benefits

  • More Accurate Representations: Sequence diagrams will fully reflect how interactions occur within the system.
  • Better Maintainability: Aligns sequence diagrams with the improved CALM model structure.
  • Richer Visualizations: By incorporating additional metadata, diagrams provide a clearer understanding of system flows.

LeighFinegold avatar Mar 17 '25 16:03 LeighFinegold