ArchDocs
Start free

Reference

type: reference

A link to another architecture doc or a catalog object: the building block of the cross-doc/object network (drives downstream-usage tracking). referenceType is architecture-doc | object and targetId is its id. Set embed: true to render the target inline instead of as a link chip; connect references with relationships like any other node. Optional width and height each accept 150-4000; defaults are 150x150 for links and 640x400 for embeds.

Examples

- { id: ordersDb, type: reference, referenceType: object, targetId: <objectId>, label: Orders DB }
- {
    id: overview,
    type: reference,
    referenceType: architecture-doc,
    targetId: <docId>,
    label: Platform Overview,
    embed: true,
    width: 960,
    height: 600,
  }