Skip to content

Core DynamicDiagram Spec

Source: core.dynamic-diagram.json

This schema describes the DynamicDiagram spec for the Core backend.

Properties

Properties

Field Type Description
type(required) string Type of the diagram. Must be exactly DynamicDiagram.
title string | null Optional diagram title.
elements array[Element] Top-level elements.
boundaries array[Boundary] Top-level boundaries.
relationships array[RelationshipSchema] Relationships declared inside the boundary.
Examples
JSON source 
{
  "type": "DynamicDiagram",
  "title": "Login Flow",
  "elements": [
    {
      "type": "Person",
      "label": "User",
      "alias": "user",
      "description": "Signs in to the application."
    },
    {
      "type": "System",
      "label": "Web App",
      "alias": "web_app",
      "description": "Main application used by customers."
    },
    {
      "type": "SystemExt",
      "label": "Identity Provider",
      "alias": "idp",
      "description": "External authentication service."
    }
  ],
  "relationships": [
    {
      "type": "REL",
      "from": "user",
      "to": "web_app",
      "label": "Opens sign-in page",
      "technology": "HTTPS"
    },
    {
      "type": "REL",
      "from": "web_app",
      "to": "idp",
      "label": "Authenticates user",
      "technology": "OIDC"
    },
    {
      "type": "REL",
      "from": "idp",
      "to": "web_app",
      "label": "Returns identity token",
      "technology": "OIDC"
    }
  ]
}
JSON source 
{
  "type": "DynamicDiagram",
  "title": "Order Fulfillment Flow",
  "elements": [
    {
      "type": "Person",
      "label": "Customer",
      "alias": "customer",
      "description": "Places orders in the online store."
    },
    {
      "type": "System",
      "label": "Online Store",
      "alias": "online_store",
      "description": "Customer-facing commerce platform."
    },
    {
      "type": "SystemExt",
      "label": "Payment Gateway",
      "alias": "payment_gateway",
      "description": "External provider that authorizes card payments."
    },
    {
      "type": "SystemExt",
      "label": "Warehouse System",
      "alias": "warehouse_system",
      "description": "External warehouse platform that reserves and ships items."
    }
  ],
  "relationships": [
    {
      "type": "REL",
      "from": "customer",
      "to": "online_store",
      "label": "Places order",
      "technology": "HTTPS"
    },
    {
      "type": "REL",
      "from": "online_store",
      "to": "payment_gateway",
      "label": "Authorizes payment",
      "technology": "REST API"
    },
    {
      "type": "REL",
      "from": "payment_gateway",
      "to": "online_store",
      "label": "Returns authorization result",
      "technology": "HTTPS"
    },
    {
      "type": "REL",
      "from": "online_store",
      "to": "warehouse_system",
      "label": "Sends fulfillment request",
      "technology": "AMQP"
    },
    {
      "type": "REL",
      "from": "warehouse_system",
      "to": "online_store",
      "label": "Confirms reservation",
      "technology": "AMQP"
    }
  ]
}

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.


ComponentDbExtSchema

This schema describes the ComponentDbExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ComponentDbExt.
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.
technology string | null Optional technology.

ComponentDbSchema

This schema describes the ComponentDb diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ComponentDb.
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.
technology string | null Optional technology.

ComponentExtSchema

This schema describes the ComponentExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ComponentExt.
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.
technology string | null Optional technology.

ComponentQueueExtSchema

This schema describes the ComponentQueueExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ComponentQueueExt.
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.
technology string | null Optional technology.

ComponentQueueSchema

This schema describes the ComponentQueue diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ComponentQueue.
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.
technology string | null Optional technology.

ComponentSchema

This schema describes the Component diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly Component.
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.
technology string | null Optional technology.

ContainerDbExtSchema

This schema describes the ContainerDbExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ContainerDbExt.
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.
technology string | null Optional technology.

ContainerDbSchema

This schema describes the ContainerDb diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ContainerDb.
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.
technology string | null Optional technology.

ContainerExtSchema

This schema describes the ContainerExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ContainerExt.
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.
technology string | null Optional technology.

ContainerQueueExtSchema

This schema describes the ContainerQueueExt diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ContainerQueueExt.
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.
technology string | null Optional technology.

ContainerQueueSchema

This schema describes the ContainerQueue diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ContainerQueue.
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.
technology string | null Optional technology.

ContainerSchema

This schema describes the Container diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly Container.
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.
technology string | null Optional technology.

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.

DynamicBoundarySchema

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.

DynamicContainerBoundarySchema

This schema describes the ContainerBoundary diagram component.

Properties

Field Type Description
type(required) string Discriminator identifying the element type. Must be exactly ContainerBoundary.
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.

DynamicEnterpriseBoundarySchema

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.

DynamicSystemBoundarySchema

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.

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).

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.