Skip to content

Core SystemContextDiagram Spec

Source: core.system-context-diagram.json

This schema describes the SystemContextDiagram spec for the Core backend.

Properties

Properties

Field Type Description
type(required) string Type of the diagram. Must be exactly SystemContextDiagram.
title string | null Optional diagram title.
elements array[Element] Top-level elements.
boundaries array[Boundary] Top-level boundaries.
relationships array[RelationshipSchema] Top-level relationships.
Examples
JSON source 
{
  "type": "SystemContextDiagram",
  "elements": [
    {
      "type": "Person",
      "alias": "user",
      "label": "User"
    },
    {
      "type": "System",
      "alias": "app",
      "label": "My App"
    }
  ],
  "relationships": [
    {
      "type": "REL",
      "from": "user",
      "to": "app",
      "label": "Uses",
      "technology": "HTTPS"
    }
  ]
}
JSON source 
{
  "type": "SystemContextDiagram",
  "title": "Retail Platform",
  "elements": [
    {
      "type": "Person",
      "label": "Customer",
      "alias": "customer",
      "description": "Places orders through the storefront."
    },
    {
      "type": "PersonExt",
      "label": "Support Agent",
      "alias": "support_agent",
      "description": "Handles issues in an external CRM."
    },
    {
      "type": "SystemExt",
      "label": "Payment Gateway",
      "alias": "payment_gateway",
      "description": "Processes card payments."
    },
    {
      "type": "SystemExt",
      "label": "CRM Platform",
      "alias": "crm_platform",
      "description": "External CRM used by support agents."
    }
  ],
  "boundaries": [
    {
      "type": "EnterpriseBoundary",
      "label": "Acme Corp",
      "alias": "acme_enterprise",
      "description": "Internal systems owned by Acme.",
      "elements": [
        {
          "type": "System",
          "label": "Retail Platform",
          "alias": "retail_platform",
          "description": "Core platform for catalog, checkout, and order management."
        }
      ],
      "boundaries": [],
      "relationships": []
    }
  ],
  "relationships": [
    {
      "type": "REL",
      "from": "customer",
      "to": "retail_platform",
      "label": "Browses and places orders",
      "technology": "HTTPS"
    },
    {
      "type": "REL",
      "from": "retail_platform",
      "to": "payment_gateway",
      "label": "Charges card",
      "technology": "REST API"
    },
    {
      "type": "REL",
      "from": "support_agent",
      "to": "crm_platform",
      "label": "Manages customer issues",
      "technology": "Web UI"
    }
  ]
}

Elements

Boundaries

Relationships

Definitions

About labels and aliases

label is a display name for the element.

alias is a unique identifier used for referencing elements in relationships and layouts. If omitted, it is generated automatically.

You can also use label for referencing elements in relationships and layouts, but each label must be unique within the diagram.


BoundarySchema

This schema describes the Boundary diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly Boundary.
elements array[Element] Elements may be nested arbitrarily.
boundaries array[Boundary] Boundaries may be nested arbitrarily.
relationships array[RelationshipSchema] Relationships declared inside the boundary.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

DiagramElementPropertiesSchema

JSON schema for tabular diagram element properties.

Properties

Field Type Description
header array[string] Header columns. Default: ["Property", "Value"].
properties(required) array[array[string]] List of rows (each row is a list of string values).
show_header boolean Whether to display the header row. Default: true.

EnterpriseBoundarySchema

This schema describes the EnterpriseBoundary diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly EnterpriseBoundary.
elements array[Element] Elements may be nested arbitrarily.
boundaries array[Boundary] Boundaries may be nested arbitrarily.
relationships array[RelationshipSchema] Relationships declared inside the boundary.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

PersonExtSchema

This schema describes the PersonExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly PersonExt.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

PersonSchema

This schema describes the Person diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly Person.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

RelationshipSchema

This schema describes the Relationship diagram component.

Properties

Field Type Description
type(required) string Type of the relationship. Must be exactly REL.
description string | null Additional details about the relationship.
from(required) string The source element alias (or unique label).
label(required) string The label shown on the relationship edge.
properties DiagramElementPropertiesSchema Optional property table metadata.
technology string | null The technology used in the communication.
to(required) string The destination element alias (or unique label).

SystemBoundarySchema

This schema describes the SystemBoundary diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly SystemBoundary.
elements array[Element] Elements may be nested arbitrarily.
boundaries array[Boundary] Boundaries may be nested arbitrarily.
relationships array[RelationshipSchema] Relationships declared inside the boundary.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

SystemDbExtSchema

This schema describes the SystemDbExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly SystemDbExt.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

SystemDbSchema

This schema describes the SystemDb diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly SystemDb.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

SystemExtSchema

This schema describes the SystemExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly SystemExt.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

SystemQueueExtSchema

This schema describes the SystemQueueExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly SystemQueueExt.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

SystemQueueSchema

This schema describes the SystemQueue diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly SystemQueue.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.

SystemSchema

This schema describes the System diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly System.
alias string | null Unique identifier for the element. If not provided, it is autogenerated from the label.
description string | null Optional description text.
label(required) string Display name for the element.
properties DiagramElementPropertiesSchema Optional property table metadata.