Core ComponentDiagram Spec¶

Source: core.component-diagram.json

This schema describes the ComponentDiagram spec for the Core backend.

Properties¶

Properties

Field	Type	Description
`type(required)`	`string`	Type of the diagram. Must be exactly `ComponentDiagram`.
`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

MinimalAdvanced

JSON source

{
  "type": "ComponentDiagram",
  "title": "Checkout API - Component Diagram",
  "elements": [
    {
      "type": "Component",
      "label": "Checkout Controller",
      "alias": "checkout_controller",
      "description": "Receives checkout requests and orchestrates payment flow.",
      "technology": "FastAPI"
    },
    {
      "type": "Component",
      "label": "Payment Service",
      "alias": "payment_service",
      "description": "Creates payment intents and handles payment state updates.",
      "technology": "Python"
    },
    {
      "type": "ComponentDb",
      "label": "Payment Store",
      "alias": "payment_store",
      "description": "Stores payment records and statuses.",
      "technology": "PostgreSQL"
    },
    {
      "type": "ComponentExt",
      "label": "Payment Gateway API",
      "alias": "payment_gateway_api",
      "description": "External API for payment authorization and capture.",
      "technology": "REST API"
    }
  ],
  "relationships": [
    {
      "type": "REL",
      "from": "checkout_controller",
      "to": "payment_service",
      "label": "Calls",
      "technology": "Python call"
    },
    {
      "type": "REL",
      "from": "payment_service",
      "to": "payment_store",
      "label": "Reads and writes",
      "technology": "SQL"
    },
    {
      "type": "REL",
      "from": "payment_service",
      "to": "payment_gateway_api",
      "label": "Creates payments via",
      "technology": "HTTPS/JSON"
    }
  ]
}

JSON source

{
  "type": "ComponentDiagram",
  "title": "Order Processing API - Component Diagram",
  "elements": [
    {
      "type": "Component",
      "label": "Order Controller",
      "alias": "order_controller",
      "description": "HTTP entrypoint for order submission and status queries.",
      "technology": "FastAPI"
    },
    {
      "type": "Component",
      "label": "Order Application Service",
      "alias": "order_app_service",
      "description": "Coordinates validation, payment, and order creation.",
      "technology": "Python"
    },
    {
      "type": "Component",
      "label": "Inventory Checker",
      "alias": "inventory_checker",
      "description": "Verifies stock availability before an order is confirmed.",
      "technology": "Python"
    },
    {
      "type": "Component",
      "label": "Payment Adapter",
      "alias": "payment_adapter",
      "description": "Wraps external payment provider calls.",
      "technology": "Python"
    },
    {
      "type": "ComponentDb",
      "label": "Order Database",
      "alias": "order_db",
      "description": "Stores orders, line items, and order status history.",
      "technology": "PostgreSQL"
    },
    {
      "type": "ComponentExt",
      "label": "Payment Gateway API",
      "alias": "payment_gateway_api",
      "description": "External provider API for payment authorization and capture.",
      "technology": "REST API"
    },
    {
      "type": "ComponentQueue",
      "label": "Order Events Bus",
      "alias": "order_events_bus",
      "description": "Publishes order-created and order-paid events.",
      "technology": "Kafka"
    }
  ],
  "relationships": [
    {
      "type": "REL",
      "from": "order_controller",
      "to": "order_app_service",
      "label": "Invokes",
      "technology": "Python call"
    },
    {
      "type": "REL",
      "from": "order_app_service",
      "to": "inventory_checker",
      "label": "Checks stock via",
      "technology": "Python call"
    },
    {
      "type": "REL",
      "from": "order_app_service",
      "to": "payment_adapter",
      "label": "Requests payment through",
      "technology": "Python call"
    },
    {
      "type": "REL",
      "from": "payment_adapter",
      "to": "payment_gateway_api",
      "label": "Authorizes payment via",
      "technology": "HTTPS/JSON"
    },
    {
      "type": "REL",
      "from": "order_app_service",
      "to": "order_db",
      "label": "Reads and writes",
      "technology": "SQL"
    },
    {
      "type": "REL",
      "from": "order_app_service",
      "to": "order_events_bus",
      "label": "Publishes events to",
      "technology": "Kafka"
    }
  ]
}

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.

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.

ContainerBoundarySchema¶

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.

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

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.

Core ComponentDiagram Spec¶

Properties¶

Elements¶

Boundaries¶

Relationships¶

Definitions¶

BoundarySchema¶

ComponentDbExtSchema¶

ComponentDbSchema¶

ComponentExtSchema¶

ComponentQueueExtSchema¶

ComponentQueueSchema¶

ComponentSchema¶

ContainerBoundarySchema¶

ContainerDbExtSchema¶

ContainerDbSchema¶

ContainerExtSchema¶

ContainerQueueExtSchema¶

ContainerQueueSchema¶

ContainerSchema¶

DiagramElementPropertiesSchema¶

EnterpriseBoundarySchema¶

PersonExtSchema¶

PersonSchema¶

RelationshipSchema¶

SystemBoundarySchema¶

SystemDbExtSchema¶

SystemDbSchema¶

SystemExtSchema¶

SystemQueueExtSchema¶

SystemQueueSchema¶

SystemSchema¶