finos / finos/architecture-as-code
Create official go to scenario with nested linked architectures
- Dominant language
- TypeScript
- Stars
- 399
- Forks
- 138
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 38
Description
## Summary
The CALM CLI currently supports the `detailed-architecture` feature in the core schema, but lacks comprehensive examples and documentation showing how to use this powerful capability. This issue proposes adding practical examples and documentation for using detailed-architectures with the CLI tools.
## Background
The `detailed-architecture` feature allows nodes to reference external CALM architecture documents that provide more granular details about a node's internal structure. This enables hierarchical architecture modeling where high-level architectures can reference detailed sub-architectures.
### Current Implementation Status ✅
- **Schema Support**: `detailed-architecture` is defined in `/calm/release/1.0/meta/core.json` as a string property in node details
- **Model Support**: `calm-models` package fully supports detailed-architecture through `ResolvableAndAdaptable`
- **Resolution Logic**: `shared` package provides URL resolution via HTTP, File, Composite, and other resolvers
- **Dereferencing**: `DereferencingVisitor` can resolve detailed-architecture URLs and populate nested models
### Missing Components
- No CLI examples demonstrating detailed-architecture usage
- No test fixtures showing practical scenarios
- Limited documentation on CLI workflow for hierarchical architectures
- No examples of URL resolution mapping for detailed-architecture
Contributor guide
Assessment
This issue has not been assessed yet.