Models API Reference

Low-level API reference for buildzr.models module.

This module contains the auto-generated Pydantic models that represent the Structurizr JSON schema. These are the underlying data structures used by the DSL classes.

models

Enterprise dataclass

The enterprise associated with this model.

Source code in buildzr/models/models.py

@dataclass
class Enterprise:
    """
    The enterprise associated with this model.
    """

    name: Optional[str] = None
    """
    The name of the enterprise.
    """

name class-attribute instance-attribute

name: Optional[str] = None

The name of the enterprise.

Location

Bases: Enum

The location of this person.

Source code in buildzr/models/models.py

class Location(Enum):
    """
    The location of this person.
    """

    External = 'External'
    Internal = 'Internal'
    Unspecified = 'Unspecified'

Location1

Bases: Enum

The location of this software system.

Source code in buildzr/models/models.py

class Location1(Enum):
    """
    The location of this software system.
    """

    External = 'External'
    Internal = 'Internal'
    Unspecified = 'Unspecified'

HttpHealthCheck dataclass

Describes a HTTP based health check.

Source code in buildzr/models/models.py

@dataclass
class HttpHealthCheck:
    """
    Describes a HTTP based health check.
    """

    name: Optional[str] = None
    """
    The name of the health check.
    """
    url: Optional[str] = None
    """
    The health check URL/endpoint.
    """
    interval: Optional[float] = None
    """
    The polling interval, in seconds.
    """
    timeout: Optional[float] = None
    """
    The timeout after which a health check is deemed as failed, in milliseconds.
    """
    headers: Optional[Dict[str, Any]] = None
    """
    A set of name-value pairs corresponding to HTTP headers that should be sent with the request.
    """

name class-attribute instance-attribute

name: Optional[str] = None

The name of the health check.

url class-attribute instance-attribute

url: Optional[str] = None

The health check URL/endpoint.

interval class-attribute instance-attribute

interval: Optional[float] = None

The polling interval, in seconds.

timeout class-attribute instance-attribute

timeout: Optional[float] = None

The timeout after which a health check is deemed as failed, in milliseconds.

headers class-attribute instance-attribute

headers: Optional[Dict[str, Any]] = None

A set of name-value pairs corresponding to HTTP headers that should be sent with the request.

InteractionStyle

Bases: Enum

The interaction style (synchronous or asynchronous).

Source code in buildzr/models/models.py

class InteractionStyle(Enum):
    """
    The interaction style (synchronous or asynchronous).
    """

    Synchronous = 'Synchronous'
    Asynchronous = 'Asynchronous'

Perspective dataclass

Represents an architectural perspective, that can be applied to elements and relationships.

Source code in buildzr/models/models.py

@dataclass
class Perspective:
    """
    Represents an architectural perspective, that can be applied to elements and relationships.
    """

    name: Optional[str] = None
    """
    The name of this perspective (e.g. "Security").
    """
    description: Optional[str] = None
    """
    The description of this perspective.
    """
    value: Optional[str] = None
    """
    The value of this perspective (optional).
    """

name class-attribute instance-attribute

name: Optional[str] = None

The name of this perspective (e.g. “Security”).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this perspective.

value class-attribute instance-attribute

value: Optional[str] = None

The value of this perspective (optional).

PaperSize

Bases: Enum

The paper size that should be used to render this view.

Source code in buildzr/models/models.py

class PaperSize(Enum):
    """
    The paper size that should be used to render this view.
    """

    A6_Portrait = 'A6_Portrait'
    A6_Landscape = 'A6_Landscape'
    A5_Portrait = 'A5_Portrait'
    A5_Landscape = 'A5_Landscape'
    A4_Portrait = 'A4_Portrait'
    A4_Landscape = 'A4_Landscape'
    A3_Portrait = 'A3_Portrait'
    A3_Landscape = 'A3_Landscape'
    A2_Portrait = 'A2_Portrait'
    A2_Landscape = 'A2_Landscape'
    A1_Portrait = 'A1_Portrait'
    A1_Landscape = 'A1_Landscape'
    A0_Portrait = 'A0_Portrait'
    A0_Landscape = 'A0_Landscape'
    Letter_Portrait = 'Letter_Portrait'
    Letter_Landscape = 'Letter_Landscape'
    Legal_Portrait = 'Legal_Portrait'
    Legal_Landscape = 'Legal_Landscape'
    Slide_4_3 = 'Slide_4_3'
    Slide_16_9 = 'Slide_16_9'
    Slide_16_10 = 'Slide_16_10'

Mode

Bases: Enum

Whether elements/relationships are being included or excluded based upon the set of tags.

Source code in buildzr/models/models.py

class Mode(Enum):
    """
    Whether elements/relationships are being included or excluded based upon the set of tags.
    """

    Include = 'Include'
    Exclude = 'Exclude'

FilteredView dataclass

Represents a view on top of a view, which can be used to include or exclude specific elements.

Source code in buildzr/models/models.py

@dataclass
class FilteredView:
    """
    Represents a view on top of a view, which can be used to include or exclude specific elements.
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    baseViewKey: Optional[str] = None
    """
    The key of the view on which this filtered view is based.
    """
    mode: Optional[Mode] = None
    """
    Whether elements/relationships are being included or excluded based upon the set of tags.
    """
    tags: Optional[List[str]] = None
    """
    The set of tags to include/exclude elements/relationships when rendering this filtered view.
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

baseViewKey class-attribute instance-attribute

baseViewKey: Optional[str] = None

The key of the view on which this filtered view is based.

mode class-attribute instance-attribute

mode: Optional[Mode] = None

Whether elements/relationships are being included or excluded based upon the set of tags.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

The set of tags to include/exclude elements/relationships when rendering this filtered view.

ImageView dataclass

A view that has been rendered elsewhere (e.g. PlantUML, Mermaid, Kroki, etc) as a image (e.g. PNG).

Source code in buildzr/models/models.py

@dataclass
class ImageView:
    """
    A view that has been rendered elsewhere (e.g. PlantUML, Mermaid, Kroki, etc) as a image (e.g. PNG).
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    elementId: Optional[str] = None
    """
    The ID of the element this view is associated with (optional).
    """
    content: Optional[str] = None
    """
    The content of this image view, which needs to be a URL or a data URI.
    """
    contentType: Optional[str] = None
    """
    The content type of this view (e.g. "image/png").
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

elementId class-attribute instance-attribute

elementId: Optional[str] = None

The ID of the element this view is associated with (optional).

content class-attribute instance-attribute

content: Optional[str] = None

The content of this image view, which needs to be a URL or a data URI.

contentType class-attribute instance-attribute

contentType: Optional[str] = None

The content type of this view (e.g. “image/png”).

ElementView dataclass

An instance of a model element (Person, Software System, Container or Component) in a View.

Source code in buildzr/models/models.py

@dataclass
class ElementView:
    """
    An instance of a model element (Person, Software System, Container or Component) in a View.
    """

    id: Optional[str] = None
    """
    The ID of the element.
    """
    x: Optional[float] = None
    """
    The horizontal position of the element when rendered.
    """
    y: Optional[float] = None
    """
    The vertical position of the element when rendered.
    """

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the element.

x class-attribute instance-attribute

x: Optional[float] = None

The horizontal position of the element when rendered.

y class-attribute instance-attribute

y: Optional[float] = None

The vertical position of the element when rendered.

Routing

Bases: Enum

The routing algorithm used when rendering this individual relationship.

Source code in buildzr/models/models.py

class Routing(Enum):
    """
    The routing algorithm used when rendering this individual relationship.
    """

    Direct = 'Direct'
    Curved = 'Curved'
    Orthogonal = 'Orthogonal'

Vertex dataclass

The X, Y coordinate of a bend in a line.

Source code in buildzr/models/models.py

@dataclass
class Vertex:
    """
    The X, Y coordinate of a bend in a line.
    """

    x: Optional[float] = None
    """
    The horizontal position of the vertex when rendered.
    """
    y: Optional[float] = None
    """
    The vertical position of the vertex when rendered.
    """

x class-attribute instance-attribute

x: Optional[float] = None

The horizontal position of the vertex when rendered.

y class-attribute instance-attribute

y: Optional[float] = None

The vertical position of the vertex when rendered.

AnimationStep dataclass

An animation step

Source code in buildzr/models/models.py

@dataclass
class AnimationStep:
    """
    An animation step
    """

    order: Optional[float] = None
    """
    The order of this animation step.
    """
    elements: Optional[List[str]] = None
    """
    The set of element IDs that should be included in this animation step.
    """
    relationships: Optional[List[str]] = None
    """
    The set of relationship IDs that should be included in this animation step.
    """

order class-attribute instance-attribute

order: Optional[float] = None

The order of this animation step.

elements class-attribute instance-attribute

elements: Optional[List[str]] = None

The set of element IDs that should be included in this animation step.

relationships class-attribute instance-attribute

relationships: Optional[List[str]] = None

The set of relationship IDs that should be included in this animation step.

Dimensions dataclass

Represents a width and height pair.

Source code in buildzr/models/models.py

@dataclass
class Dimensions:
    """
    Represents a width and height pair.
    """

    width: Optional[float] = None
    """
    The width (pixels).
    """
    height: Optional[float] = None
    """
    The height (pixels).
    """

width class-attribute instance-attribute

width: Optional[float] = None

The width (pixels).

height class-attribute instance-attribute

height: Optional[float] = None

The height (pixels).

Implementation

Bases: Enum

The automatic layout implementation.

Source code in buildzr/models/models.py

class Implementation(Enum):
    """
    The automatic layout implementation.
    """

    Graphviz = 'Graphviz'
    Dagre = 'Dagre'

RankDirection

Bases: Enum

The algorithm rank direction.

Source code in buildzr/models/models.py

class RankDirection(Enum):
    """
    The algorithm rank direction.
    """

    TopBottom = 'TopBottom'
    BottomTop = 'BottomTop'
    LeftRight = 'LeftRight'
    RightLeft = 'RightLeft'

AutomaticLayout dataclass

Represents the auto-layout configuration for a given view.

Source code in buildzr/models/models.py

@dataclass
class AutomaticLayout:
    """
    Represents the auto-layout configuration for a given view.
    """

    implementation: Optional[Implementation] = None
    """
    The automatic layout implementation.
    """
    rankDirection: Optional[RankDirection] = None
    """
    The algorithm rank direction.
    """
    rankSeparation: Optional[float] = None
    """
    The separation between ranks (pixels).
    """
    nodeSeparation: Optional[float] = None
    """
    The separation between nodes in the same rank (pixels).
    """
    edgeSeparation: Optional[float] = None
    """
    The separation between edges (pixels).
    """
    vertices: Optional[bool] = None
    """
    Whether vertices should be created during automatic layout.
    """

implementation class-attribute instance-attribute

implementation: Optional[Implementation] = None

The automatic layout implementation.

rankDirection class-attribute instance-attribute

rankDirection: Optional[RankDirection] = None

The algorithm rank direction.

rankSeparation class-attribute instance-attribute

rankSeparation: Optional[float] = None

The separation between ranks (pixels).

nodeSeparation class-attribute instance-attribute

nodeSeparation: Optional[float] = None

The separation between nodes in the same rank (pixels).

edgeSeparation class-attribute instance-attribute

edgeSeparation: Optional[float] = None

The separation between edges (pixels).

vertices class-attribute instance-attribute

vertices: Optional[bool] = None

Whether vertices should be created during automatic layout.

MetadataSymbols

Bases: Enum

The type of symbols to use when rendering metadata.

Source code in buildzr/models/models.py

class MetadataSymbols(Enum):
    """
    The type of symbols to use when rendering metadata.
    """

    SquareBrackets_ = 'SquareBrackets,'
    RoundBrackets_ = 'RoundBrackets,'
    CurlyBrackets_ = 'CurlyBrackets,'
    AngleBrackets_ = 'AngleBrackets,'
    DoubleAngleBrackets_ = 'DoubleAngleBrackets,'
    None_ = 'None'

Font dataclass

Represents a font, including a name and an optional URL for web fonts.

Source code in buildzr/models/models.py

@dataclass
class Font:
    """
    Represents a font, including a name and an optional URL for web fonts.
    """

    name: Optional[str] = None
    """
    The font name (e.g. "Times New Roman", "Open Sans", etc).
    """
    url: Optional[str] = None
    """
    For web fonts, the URL where the font can be found.
    """

name class-attribute instance-attribute

name: Optional[str] = None

The font name (e.g. “Times New Roman”, “Open Sans”, etc).

url class-attribute instance-attribute

url: Optional[str] = None

For web fonts, the URL where the font can be found.

Branding dataclass

A wrapper for the font and logo for diagram/documentation branding purposes.

Source code in buildzr/models/models.py

@dataclass
class Branding:
    """
    A wrapper for the font and logo for diagram/documentation branding purposes.
    """

    logo: Optional[str] = None
    """
    A Base64 data URI representation of a PNG/JPG/GIF file.
    """
    font: Optional[Font] = None
    """
    Represents a font, including a name and an optional URL for web fonts.
    """

logo class-attribute instance-attribute

logo: Optional[str] = None

A Base64 data URI representation of a PNG/JPG/GIF file.

font class-attribute instance-attribute

font: Optional[Font] = None

Represents a font, including a name and an optional URL for web fonts.

Shape

Bases: Enum

The shape used to render the element.

Source code in buildzr/models/models.py

class Shape(Enum):
    """
    The shape used to render the element.
    """

    Box = 'Box'
    RoundedBox = 'RoundedBox'
    Component = 'Component'
    Circle = 'Circle'
    Ellipse = 'Ellipse'
    Hexagon = 'Hexagon'
    Diamond = 'Diamond'
    Folder = 'Folder'
    Cylinder = 'Cylinder'
    Pipe = 'Pipe'
    WebBrowser = 'WebBrowser'
    Window = 'Window'
    MobileDevicePortrait = 'MobileDevicePortrait'
    MobileDeviceLandscape = 'MobileDeviceLandscape'
    Person = 'Person'
    Robot = 'Robot'

Border

Bases: Enum

The type of border used to render the element.

Source code in buildzr/models/models.py

class Border(Enum):
    """
    The type of border used to render the element.
    """

    Solid = 'Solid'
    Dashed = 'Dashed'
    Dotted = 'Dotted'

ElementStyle dataclass

A definition of an element style.

Source code in buildzr/models/models.py

@dataclass
class ElementStyle:
    """
    A definition of an element style.
    """

    tag: Optional[str] = None
    """
    The tag to which this element style applies.
    """
    width: Optional[float] = None
    """
    The width of the element, in pixels.
    """
    height: Optional[float] = None
    """
    The height of the element, in pixels.
    """
    background: Optional[str] = None
    """
    The background colour of the element, as a HTML RGB hex string (e.g. '#ffffff').
    """
    stroke: Optional[str] = None
    """
    The stroke colour of the element, as a HTML RGB hex string (e.g. '#000000').
    """
    strokeWidth: Optional[float] = None
    """
    The width of the stroke, in pixels.
    """
    color: Optional[str] = None
    """
    The foreground (text) colour of the element, as a HTML RGB hex string (e.g. '#ffffff').
    """
    fontSize: Optional[float] = None
    """
    The standard font size used to render text, in pixels.
    """
    shape: Optional[Shape] = None
    """
    The shape used to render the element.
    """
    icon: Optional[str] = None
    """
    A Base64 data URI representation of a PNG/JPG/GIF file.
    """
    border: Optional[Border] = None
    """
    The type of border used to render the element.
    """
    opacity: Optional[float] = None
    """
    The opacity used when rendering the element; 0-100.
    """
    metadata: Optional[bool] = None
    """
    Whether the element metadata should be shown or not.
    """
    description: Optional[bool] = None
    """
    Whether the element description should be shown or not.
    """

tag class-attribute instance-attribute

tag: Optional[str] = None

The tag to which this element style applies.

width class-attribute instance-attribute

width: Optional[float] = None

The width of the element, in pixels.

height class-attribute instance-attribute

height: Optional[float] = None

The height of the element, in pixels.

background class-attribute instance-attribute

background: Optional[str] = None

The background colour of the element, as a HTML RGB hex string (e.g. ‘#ffffff’).

stroke class-attribute instance-attribute

stroke: Optional[str] = None

The stroke colour of the element, as a HTML RGB hex string (e.g. ‘#000000’).

strokeWidth class-attribute instance-attribute

strokeWidth: Optional[float] = None

The width of the stroke, in pixels.

color class-attribute instance-attribute

color: Optional[str] = None

The foreground (text) colour of the element, as a HTML RGB hex string (e.g. ‘#ffffff’).

fontSize class-attribute instance-attribute

fontSize: Optional[float] = None

The standard font size used to render text, in pixels.

shape class-attribute instance-attribute

shape: Optional[Shape] = None

The shape used to render the element.

icon class-attribute instance-attribute

icon: Optional[str] = None

A Base64 data URI representation of a PNG/JPG/GIF file.

border class-attribute instance-attribute

border: Optional[Border] = None

The type of border used to render the element.

opacity class-attribute instance-attribute

opacity: Optional[float] = None

The opacity used when rendering the element; 0-100.

metadata class-attribute instance-attribute

metadata: Optional[bool] = None

Whether the element metadata should be shown or not.

description class-attribute instance-attribute

description: Optional[bool] = None

Whether the element description should be shown or not.

Routing1

Bases: Enum

The routing algorithm used when rendering lines.

Source code in buildzr/models/models.py

class Routing1(Enum):
    """
    The routing algorithm used when rendering lines.
    """

    Direct = 'Direct'
    Curved = 'Curved'
    Orthogonal = 'Orthogonal'

RelationshipStyle dataclass

A definition of a relationship style.

Source code in buildzr/models/models.py

@dataclass
class RelationshipStyle:
    """
    A definition of a relationship style.
    """

    tag: Optional[str] = None
    """
    The tag to which this relationship style applies.
    """
    thickness: Optional[float] = None
    """
    The thickness of the line, in pixels.
    """
    color: Optional[str] = None
    """
    The colour of the line, as a HTML RGB hex string (e.g. '#ffffff').
    """
    fontSize: Optional[float] = None
    """
    The standard font size used to render the relationship annotation, in pixels.
    """
    width: Optional[float] = None
    """
    The width of the relationship annotation, in pixels.
    """
    dashed: Optional[bool] = None
    """
    A flag to indicate whether the line is rendered as dashed or not.
    """
    routing: Optional[Routing1] = None
    """
    The routing algorithm used when rendering lines.
    """
    position: Optional[float] = None
    """
    The position of the annotation along the line; 0 (start) to 100 (end).
    """
    opacity: Optional[float] = None
    """
    The opacity used when rendering the line; 0-100.
    """

tag class-attribute instance-attribute

tag: Optional[str] = None

The tag to which this relationship style applies.

thickness class-attribute instance-attribute

thickness: Optional[float] = None

The thickness of the line, in pixels.

color class-attribute instance-attribute

color: Optional[str] = None

The colour of the line, as a HTML RGB hex string (e.g. ‘#ffffff’).

fontSize class-attribute instance-attribute

fontSize: Optional[float] = None

The standard font size used to render the relationship annotation, in pixels.

width class-attribute instance-attribute

width: Optional[float] = None

The width of the relationship annotation, in pixels.

dashed class-attribute instance-attribute

dashed: Optional[bool] = None

A flag to indicate whether the line is rendered as dashed or not.

routing class-attribute instance-attribute

routing: Optional[Routing1] = None

The routing algorithm used when rendering lines.

position class-attribute instance-attribute

position: Optional[float] = None

The position of the annotation along the line; 0 (start) to 100 (end).

opacity class-attribute instance-attribute

opacity: Optional[float] = None

The opacity used when rendering the line; 0-100.

Format

Bases: Enum

The content format type.

Source code in buildzr/models/models.py

class Format(Enum):
    """
    The content format type.
    """

    Markdown = 'Markdown'
    AsciiDoc = 'AsciiDoc'

DocumentationSection dataclass

A documentation section.

Source code in buildzr/models/models.py

@dataclass
class DocumentationSection:
    """
    A documentation section.
    """

    content: Optional[str] = None
    """
    The Markdown or AsciiDoc content of the section.
    """
    format: Optional[Format] = None
    """
    The content format type.
    """
    order: Optional[float] = None
    """
    The order (index) of the section in the document.
    """

content class-attribute instance-attribute

content: Optional[str] = None

The Markdown or AsciiDoc content of the section.

format class-attribute instance-attribute

format: Optional[Format] = None

The content format type.

order class-attribute instance-attribute

order: Optional[float] = None

The order (index) of the section in the document.

Status

Bases: Enum

The status of the decision.

Source code in buildzr/models/models.py

class Status(Enum):
    """
    The status of the decision.
    """

    Proposed = 'Proposed'
    Accepted = 'Accepted'
    Superseded = 'Superseded'
    Deprecated = 'Deprecated'
    Rejected = 'Rejected'

Decision dataclass

A decision record (e.g. architecture decision record).

Source code in buildzr/models/models.py

@dataclass
class Decision:
    """
    A decision record (e.g. architecture decision record).
    """

    id: Optional[str] = None
    """
    The ID of the decision.
    """
    date: Optional[str] = None
    """
    The date that the decision was made (ISO 8601 format).
    """
    status: Optional[Status] = None
    """
    The status of the decision.
    """
    title: Optional[str] = None
    """
    The title of the decision.
    """
    content: Optional[str] = None
    """
    The Markdown or AsciiDoc content of the section.
    """
    format: Optional[Format] = None
    """
    The content format type.
    """
    elementId: Optional[str] = None
    """
    The ID of the element (in the model) that this decision applies to (optional).
    """

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the decision.

date class-attribute instance-attribute

date: Optional[str] = None

The date that the decision was made (ISO 8601 format).

status class-attribute instance-attribute

status: Optional[Status] = None

The status of the decision.

title class-attribute instance-attribute

title: Optional[str] = None

The title of the decision.

content class-attribute instance-attribute

content: Optional[str] = None

The Markdown or AsciiDoc content of the section.

format class-attribute instance-attribute

format: Optional[Format] = None

The content format type.

elementId class-attribute instance-attribute

elementId: Optional[str] = None

The ID of the element (in the model) that this decision applies to (optional).

Image dataclass

Represents a base64 encoded image (png/jpg/gif).

Source code in buildzr/models/models.py

@dataclass
class Image:
    """
    Represents a base64 encoded image (png/jpg/gif).
    """

    name: Optional[str] = None
    """
    The name of the image.
    """
    content: Optional[str] = None
    """
    The (base64 encoded) content of the image.
    """
    type: Optional[str] = None
    """
    The image MIME type (e.g. "image/png").
    """

name class-attribute instance-attribute

name: Optional[str] = None

The name of the image.

content class-attribute instance-attribute

content: Optional[str] = None

The (base64 encoded) content of the image.

type class-attribute instance-attribute

type: Optional[str] = None

The image MIME type (e.g. “image/png”).

Terminology dataclass

Provides a way for the terminology on diagrams, etc to be modified (e.g. language translations).

Source code in buildzr/models/models.py

@dataclass
class Terminology:
    """
    Provides a way for the terminology on diagrams, etc to be modified (e.g. language translations).
    """

    enterprise: Optional[str] = None
    """
    The terminology used when rendering the enterprise boundary.
    """
    person: Optional[str] = None
    """
    The terminology used when rendering people.
    """
    softwareSystem: Optional[str] = None
    """
    The terminology used when rendering software systems.
    """
    container: Optional[str] = None
    """
    The terminology used when rendering containers.
    """
    component: Optional[str] = None
    """
    The terminology used when rendering components.
    """
    code: Optional[str] = None
    """
    The terminology used when rendering code elements.
    """
    deploymentNode: Optional[str] = None
    """
    The terminology used when rendering deployment nodes.
    """
    relationship: Optional[str] = None
    """
    The terminology used when rendering relationships.
    """

enterprise class-attribute instance-attribute

enterprise: Optional[str] = None

The terminology used when rendering the enterprise boundary.

person class-attribute instance-attribute

person: Optional[str] = None

The terminology used when rendering people.

softwareSystem class-attribute instance-attribute

softwareSystem: Optional[str] = None

The terminology used when rendering software systems.

container class-attribute instance-attribute

container: Optional[str] = None

The terminology used when rendering containers.

component class-attribute instance-attribute

component: Optional[str] = None

The terminology used when rendering components.

code class-attribute instance-attribute

code: Optional[str] = None

The terminology used when rendering code elements.

deploymentNode class-attribute instance-attribute

deploymentNode: Optional[str] = None

The terminology used when rendering deployment nodes.

relationship class-attribute instance-attribute

relationship: Optional[str] = None

The terminology used when rendering relationships.

Visibility

Bases: Enum

The visibility of the workspace

Source code in buildzr/models/models.py

class Visibility(Enum):
    """
    The visibility of the workspace
    """

    Public = 'Public'
    Private = 'Private'

Scope

Bases: Enum

The scope of the workspace (can be unset for unscoped).

Source code in buildzr/models/models.py

class Scope(Enum):
    """
    The scope of the workspace (can be unset for unscoped).
    """

    Landscape = 'Landscape'
    SoftwareSystem = 'SoftwareSystem'

Role

Bases: Enum

The user’s role.

Source code in buildzr/models/models.py

class Role(Enum):
    """
    The user's role.
    """

    ReadWrite = 'ReadWrite'
    ReadOnly = 'ReadOnly'

User dataclass

Represents a user who should have access to a workspace.

Source code in buildzr/models/models.py

@dataclass
class User:
    """
    Represents a user who should have access to a workspace.
    """

    username: Optional[str] = None
    """
    The username of the user (e.g. e-mail address).
    """
    role: Optional[Role] = None
    """
    The user's role.
    """

username class-attribute instance-attribute

username: Optional[str] = None

The username of the user (e.g. e-mail address).

role class-attribute instance-attribute

role: Optional[Role] = None

The user’s role.

APIResponse dataclass

An API response.

Source code in buildzr/models/models.py

@dataclass
class APIResponse:
    """
    An API response.
    """

    success: Optional[bool] = None
    """
    true if the API call was successful, false otherwise.
    """
    message: Optional[str] = None
    """
    A human readable response message.
    """
    revision: Optional[int] = None
    """
    The internal revision number.
    """

success class-attribute instance-attribute

success: Optional[bool] = None

true if the API call was successful, false otherwise.

message class-attribute instance-attribute

message: Optional[str] = None

A human readable response message.

revision class-attribute instance-attribute

revision: Optional[int] = None

The internal revision number.

Relationship dataclass

A relationship between two elements.

Source code in buildzr/models/models.py

@dataclass
class Relationship:
    """
    A relationship between two elements.
    """

    id: Optional[str] = None
    """
    The ID of this relationship in the model.
    """
    description: Optional[str] = None
    """
    A short description of this relationship.
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this relationship.
    """
    url: Optional[str] = None
    """
    The URL where more information about this relationship can be found.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this relationship.
    """
    sourceId: Optional[str] = None
    """
    The ID of the source element.
    """
    destinationId: Optional[str] = None
    """
    The ID of the destination element.
    """
    technology: Optional[str] = None
    """
    The technology associated with this relationship (e.g. HTTPS, JDBC, etc).
    """
    interactionStyle: Optional[InteractionStyle] = None
    """
    The interaction style (synchronous or asynchronous).
    """
    linkedRelationshipId: Optional[str] = None
    """
    The ID of the container-container relationship upon which this container instance-container instance relationship is based.
    """

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this relationship in the model.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of this relationship.

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this relationship.

url class-attribute instance-attribute

url: Optional[str] = None

The URL where more information about this relationship can be found.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this relationship.

sourceId class-attribute instance-attribute

sourceId: Optional[str] = None

The ID of the source element.

destinationId class-attribute instance-attribute

destinationId: Optional[str] = None

The ID of the destination element.

technology class-attribute instance-attribute

technology: Optional[str] = None

The technology associated with this relationship (e.g. HTTPS, JDBC, etc).

interactionStyle class-attribute instance-attribute

interactionStyle: Optional[InteractionStyle] = None

The interaction style (synchronous or asynchronous).

linkedRelationshipId class-attribute instance-attribute

linkedRelationshipId: Optional[str] = None

The ID of the container-container relationship upon which this container instance-container instance relationship is based.

RelationshipView dataclass

An instance of a model relationship in a View.

Source code in buildzr/models/models.py

@dataclass
class RelationshipView:
    """
    An instance of a model relationship in a View.
    """

    id: Optional[str] = None
    """
    The ID of the relationship.
    """
    description: Optional[str] = None
    """
    The description of this relationship (used in dynamic views only).
    """
    response: Optional[bool] = None
    """
    Signifies whether this relationship represents a return/response message (used in dynamic views only).
    """
    order: Optional[str] = None
    """
    Gets the order of this relationship (used in dynamic views only; e.g. 1.0, 1.1, 2.0, etc).
    """
    vertices: Optional[List[Vertex]] = None
    """
    The set of vertices used to render the relationship.
    """
    routing: Optional[Routing] = None
    """
    The routing algorithm used when rendering this individual relationship.
    """
    position: Optional[float] = None
    """
    The position of the annotation along the line; 0 (start) to 100 (end).
    """

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the relationship.

description class-attribute instance-attribute

description: Optional[str] = None

The description of this relationship (used in dynamic views only).

response class-attribute instance-attribute

response: Optional[bool] = None

Signifies whether this relationship represents a return/response message (used in dynamic views only).

order class-attribute instance-attribute

order: Optional[str] = None

Gets the order of this relationship (used in dynamic views only; e.g. 1.0, 1.1, 2.0, etc).

vertices class-attribute instance-attribute

vertices: Optional[List[Vertex]] = None

The set of vertices used to render the relationship.

routing class-attribute instance-attribute

routing: Optional[Routing] = None

The routing algorithm used when rendering this individual relationship.

position class-attribute instance-attribute

position: Optional[float] = None

The position of the annotation along the line; 0 (start) to 100 (end).

Styles dataclass

The styles associated with this set of views.

Source code in buildzr/models/models.py

@dataclass
class Styles:
    """
    The styles associated with this set of views.
    """

    elements: Optional[List[ElementStyle]] = None
    """
    The set of element styles.
    """
    relationships: Optional[List[RelationshipStyle]] = None
    """
    The set of relationship styles.
    """

elements class-attribute instance-attribute

elements: Optional[List[ElementStyle]] = None

The set of element styles.

relationships class-attribute instance-attribute

relationships: Optional[List[RelationshipStyle]] = None

The set of relationship styles.

Configuration dataclass

The configuration associated with a set of views.

Source code in buildzr/models/models.py

@dataclass
class Configuration:
    """
    The configuration associated with a set of views.
    """

    styles: Optional[Styles] = None
    """
    The styles associated with this set of views.
    """
    lastSavedView: Optional[str] = None
    """
    The key of the view that was saved most recently.
    """
    defaultView: Optional[str] = None
    """
    The key of the view that should be shown by default.
    """
    themes: Optional[List[str]] = None
    """
    The URL(s) of the theme(s) to be used when rendering diagrams.
    """
    branding: Optional[Branding] = None
    terminology: Optional[Terminology] = None
    metadataSymbols: Optional[MetadataSymbols] = None
    """
    The type of symbols to use when rendering metadata.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """

styles class-attribute instance-attribute

styles: Optional[Styles] = None

The styles associated with this set of views.

lastSavedView class-attribute instance-attribute

lastSavedView: Optional[str] = None

The key of the view that was saved most recently.

defaultView class-attribute instance-attribute

defaultView: Optional[str] = None

The key of the view that should be shown by default.

themes class-attribute instance-attribute

themes: Optional[List[str]] = None

The URL(s) of the theme(s) to be used when rendering diagrams.

metadataSymbols class-attribute instance-attribute

metadataSymbols: Optional[MetadataSymbols] = None

The type of symbols to use when rendering metadata.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

Documentation dataclass

A wrapper for documentation.

Source code in buildzr/models/models.py

@dataclass
class Documentation:
    """
    A wrapper for documentation.
    """

    sections: Optional[List[DocumentationSection]] = None
    decisions: Optional[List[Decision]] = None
    images: Optional[List[Image]] = None

WorkspaceConfiguration dataclass

The workspace configuration (for Structurizr cloud service and on-premises installation).

Source code in buildzr/models/models.py

@dataclass
class WorkspaceConfiguration:
    """
    The workspace configuration (for Structurizr cloud service and on-premises installation).
    """

    users: Optional[List[User]] = None
    visibility: Optional[Visibility] = None
    """
    The visibility of the workspace
    """
    scope: Optional[Scope] = None
    """
    The scope of the workspace (can be unset for unscoped).
    """

visibility class-attribute instance-attribute

visibility: Optional[Visibility] = None

The visibility of the workspace

scope class-attribute instance-attribute

scope: Optional[Scope] = None

The scope of the workspace (can be unset for unscoped).

Person dataclass

A person who uses a software system.

Source code in buildzr/models/models.py

@dataclass
class Person:
    """
    A person who uses a software system.
    """

    id: Optional[str] = None
    """
    The ID of this person in the model.
    """
    name: Optional[str] = None
    """
    The name of this person.
    """
    description: Optional[str] = None
    """
    A short description of this person.
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this person.
    """
    url: Optional[str] = None
    """
    The URL where more information about this element can be found.
    """
    location: Optional[Location] = None
    """
    The location of this person.
    """
    group: Optional[str] = None
    """
    The name of the group in which this person should be included in.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this person to other elements.
    """

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this person in the model.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this person.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of this person.

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this person.

url class-attribute instance-attribute

url: Optional[str] = None

The URL where more information about this element can be found.

location class-attribute instance-attribute

location: Optional[Location] = None

The location of this person.

group class-attribute instance-attribute

group: Optional[str] = None

The name of the group in which this person should be included in.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this person to other elements.

Component dataclass

A component (a grouping of related functionality behind an interface that runs inside a container).

Source code in buildzr/models/models.py

@dataclass
class Component:
    """
    A component (a grouping of related functionality behind an interface that runs inside a container).
    """

    id: Optional[str] = None
    """
    The ID of this component in the model.
    """
    name: Optional[str] = None
    """
    The name of this component.
    """
    description: Optional[str] = None
    """
    A short description of this component.
    """
    technology: Optional[str] = None
    """
    The technology associated with this component (e.g. Spring Bean).
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this component.
    """
    url: Optional[str] = None
    """
    The URL where more information about this element can be found.
    """
    group: Optional[str] = None
    """
    The name of the group in which this component should be included in.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this component to other elements.
    """
    documentation: Optional[Documentation] = None

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this component in the model.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this component.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of this component.

technology class-attribute instance-attribute

technology: Optional[str] = None

The technology associated with this component (e.g. Spring Bean).

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this component.

url class-attribute instance-attribute

url: Optional[str] = None

The URL where more information about this element can be found.

group class-attribute instance-attribute

group: Optional[str] = None

The name of the group in which this component should be included in.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this component to other elements.

InfrastructureNode dataclass

An infrastructure node.

Source code in buildzr/models/models.py

@dataclass
class InfrastructureNode:
    """
    An infrastructure node.
    """

    id: Optional[str] = None
    """
    The ID of this infrastructure node in the model.
    """
    name: Optional[str] = None
    """
    The name of this infrastructure node.
    """
    description: Optional[str] = None
    """
    A short description of this infrastructure node.
    """
    technology: Optional[str] = None
    """
    The technology associated with this infrastructure node (e.g. "Route 53").
    """
    environment: Optional[str] = None
    """
    The deployment environment in which this infrastructure node resides (e.g. "Development", "Live", etc).
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this infrastructure node.
    """
    url: Optional[str] = None
    """
    The URL where more information about this element can be found.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this infrastructure node to other elements.
    """

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this infrastructure node in the model.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this infrastructure node.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of this infrastructure node.

technology class-attribute instance-attribute

technology: Optional[str] = None

The technology associated with this infrastructure node (e.g. “Route 53”).

environment class-attribute instance-attribute

environment: Optional[str] = None

The deployment environment in which this infrastructure node resides (e.g. “Development”, “Live”, etc).

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this infrastructure node.

url class-attribute instance-attribute

url: Optional[str] = None

The URL where more information about this element can be found.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this infrastructure node to other elements.

SoftwareSystemInstance dataclass

An instance of a software system, running on a deployment node.

Source code in buildzr/models/models.py

@dataclass
class SoftwareSystemInstance:
    """
    An instance of a software system, running on a deployment node.
    """

    id: Optional[str] = None
    """
    The ID of this software system instance in the model.
    """
    softwareSystemId: Optional[str] = None
    """
    The ID of the software system this is an instance of.
    """
    instanceId: Optional[float] = None
    """
    The number/index of this instance.
    """
    environment: Optional[str] = None
    """
    The deployment environment in which this software system instance resides (e.g. "Development", "Live", etc).
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this software system instance.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this software system instance to other elements.
    """
    healthChecks: Optional[List[HttpHealthCheck]] = None
    """
    The set of HTTP-based health checks for this software system instance.
    """
    deploymentGroups: Optional[List[str]] = None

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this software system instance in the model.

softwareSystemId class-attribute instance-attribute

softwareSystemId: Optional[str] = None

The ID of the software system this is an instance of.

instanceId class-attribute instance-attribute

instanceId: Optional[float] = None

The number/index of this instance.

environment class-attribute instance-attribute

environment: Optional[str] = None

The deployment environment in which this software system instance resides (e.g. “Development”, “Live”, etc).

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this software system instance.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this software system instance to other elements.

healthChecks class-attribute instance-attribute

healthChecks: Optional[List[HttpHealthCheck]] = None

The set of HTTP-based health checks for this software system instance.

ContainerInstance dataclass

An instance of a container, running on a deployment node.

Source code in buildzr/models/models.py

@dataclass
class ContainerInstance:
    """
    An instance of a container, running on a deployment node.
    """

    id: Optional[str] = None
    """
    The ID of this container instance in the model.
    """
    containerId: Optional[str] = None
    """
    The ID of the container this is an instance of.
    """
    instanceId: Optional[float] = None
    """
    The number/index of this instance.
    """
    environment: Optional[str] = None
    """
    The deployment environment in which this container instance resides (e.g. "Development", "Live", etc).
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this container instance.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this container instance to other elements.
    """
    healthChecks: Optional[List[HttpHealthCheck]] = None
    """
    The set of HTTP-based health checks for this container instance.
    """
    deploymentGroups: Optional[List[str]] = None

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this container instance in the model.

containerId class-attribute instance-attribute

containerId: Optional[str] = None

The ID of the container this is an instance of.

instanceId class-attribute instance-attribute

instanceId: Optional[float] = None

The number/index of this instance.

environment class-attribute instance-attribute

environment: Optional[str] = None

The deployment environment in which this container instance resides (e.g. “Development”, “Live”, etc).

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this container instance.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this container instance to other elements.

healthChecks class-attribute instance-attribute

healthChecks: Optional[List[HttpHealthCheck]] = None

The set of HTTP-based health checks for this container instance.

SystemLandscapeView dataclass

A system landscape view.

Source code in buildzr/models/models.py

@dataclass
class SystemLandscapeView:
    """
    A system landscape view.
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    paperSize: Optional[PaperSize] = None
    """
    The paper size that should be used to render this view.
    """
    dimensions: Optional[Dimensions] = None
    automaticLayout: Optional[AutomaticLayout] = None
    enterpriseBoundaryVisible: Optional[bool] = None
    """
    Specifies whether the enterprise boundary (to differentiate internal elements from external elements) should be visible on the resulting diagram.
    """
    elements: Optional[List[ElementView]] = None
    """
    The set of elements in this views.
    """
    relationships: Optional[List[RelationshipView]] = None
    """
    The set of relationships in this views.
    """
    animations: Optional[List[AnimationStep]] = None
    """
    The set of animation steps (optional).
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

paperSize class-attribute instance-attribute

paperSize: Optional[PaperSize] = None

The paper size that should be used to render this view.

enterpriseBoundaryVisible class-attribute instance-attribute

enterpriseBoundaryVisible: Optional[bool] = None

Specifies whether the enterprise boundary (to differentiate internal elements from external elements) should be visible on the resulting diagram.

elements class-attribute instance-attribute

elements: Optional[List[ElementView]] = None

The set of elements in this views.

relationships class-attribute instance-attribute

relationships: Optional[List[RelationshipView]] = None

The set of relationships in this views.

animations class-attribute instance-attribute

animations: Optional[List[AnimationStep]] = None

The set of animation steps (optional).

SystemContextView dataclass

A system context view.

Source code in buildzr/models/models.py

@dataclass
class SystemContextView:
    """
    A system context view.
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    softwareSystemId: Optional[str] = None
    """
    The ID of the software system this view is associated with.
    """
    paperSize: Optional[PaperSize] = None
    """
    The paper size that should be used to render this view.
    """
    dimensions: Optional[Dimensions] = None
    automaticLayout: Optional[AutomaticLayout] = None
    enterpriseBoundaryVisible: Optional[bool] = None
    """
    Specifies whether the enterprise boundary (to differentiate internal elements from external elements") should be visible on the resulting diagram.
    """
    elements: Optional[List[ElementView]] = None
    """
    The set of elements in this view.
    """
    relationships: Optional[List[RelationshipView]] = None
    """
    The set of relationships in this view.
    """
    animations: Optional[List[AnimationStep]] = None
    """
    The set of animation steps (optional).
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

softwareSystemId class-attribute instance-attribute

softwareSystemId: Optional[str] = None

The ID of the software system this view is associated with.

paperSize class-attribute instance-attribute

paperSize: Optional[PaperSize] = None

The paper size that should be used to render this view.

enterpriseBoundaryVisible class-attribute instance-attribute

enterpriseBoundaryVisible: Optional[bool] = None

Specifies whether the enterprise boundary (to differentiate internal elements from external elements”) should be visible on the resulting diagram.

elements class-attribute instance-attribute

elements: Optional[List[ElementView]] = None

The set of elements in this view.

relationships class-attribute instance-attribute

relationships: Optional[List[RelationshipView]] = None

The set of relationships in this view.

animations class-attribute instance-attribute

animations: Optional[List[AnimationStep]] = None

The set of animation steps (optional).

ContainerView dataclass

A container view.

Source code in buildzr/models/models.py

@dataclass
class ContainerView:
    """
    A container view.
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    softwareSystemId: Optional[str] = None
    """
    The ID of the software system this view is associated with.
    """
    paperSize: Optional[PaperSize] = None
    """
    The paper size that should be used to render this view.
    """
    dimensions: Optional[Dimensions] = None
    automaticLayout: Optional[AutomaticLayout] = None
    elements: Optional[List[ElementView]] = None
    """
    The set of elements in this views.
    """
    relationships: Optional[List[RelationshipView]] = None
    """
    The set of relationships in this views.
    """
    animations: Optional[List[AnimationStep]] = None
    """
    The set of animation steps (optional).
    """
    externalSoftwareSystemBoundariesVisible: Optional[bool] = None
    """
    Specifies whether software system boundaries should be visible for "external" containers (those outside the software system in scope).
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

softwareSystemId class-attribute instance-attribute

softwareSystemId: Optional[str] = None

The ID of the software system this view is associated with.

paperSize class-attribute instance-attribute

paperSize: Optional[PaperSize] = None

The paper size that should be used to render this view.

elements class-attribute instance-attribute

elements: Optional[List[ElementView]] = None

The set of elements in this views.

relationships class-attribute instance-attribute

relationships: Optional[List[RelationshipView]] = None

The set of relationships in this views.

animations class-attribute instance-attribute

animations: Optional[List[AnimationStep]] = None

The set of animation steps (optional).

externalSoftwareSystemBoundariesVisible class-attribute instance-attribute

externalSoftwareSystemBoundariesVisible: Optional[bool] = None

Specifies whether software system boundaries should be visible for “external” containers (those outside the software system in scope).

ComponentView dataclass

A component view.

Source code in buildzr/models/models.py

@dataclass
class ComponentView:
    """
    A component view.
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    containerId: Optional[str] = None
    """
    The ID of the container this view is associated with.
    """
    paperSize: Optional[PaperSize] = None
    """
    The paper size that should be used to render this view.
    """
    dimensions: Optional[Dimensions] = None
    automaticLayout: Optional[AutomaticLayout] = None
    elements: Optional[List[ElementView]] = None
    """
    The set of elements in this views.
    """
    relationships: Optional[List[RelationshipView]] = None
    """
    The set of relationships in this views.
    """
    animations: Optional[List[AnimationStep]] = None
    """
    The set of animation steps (optional).
    """
    externalContainerBoundariesVisible: Optional[bool] = None
    """
    Specifies whether container boundaries should be visible for "external" components (those outside the container in scope).
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

containerId class-attribute instance-attribute

containerId: Optional[str] = None

The ID of the container this view is associated with.

paperSize class-attribute instance-attribute

paperSize: Optional[PaperSize] = None

The paper size that should be used to render this view.

elements class-attribute instance-attribute

elements: Optional[List[ElementView]] = None

The set of elements in this views.

relationships class-attribute instance-attribute

relationships: Optional[List[RelationshipView]] = None

The set of relationships in this views.

animations class-attribute instance-attribute

animations: Optional[List[AnimationStep]] = None

The set of animation steps (optional).

externalContainerBoundariesVisible class-attribute instance-attribute

externalContainerBoundariesVisible: Optional[bool] = None

Specifies whether container boundaries should be visible for “external” components (those outside the container in scope).

DynamicView dataclass

A dynamic view.

Source code in buildzr/models/models.py

@dataclass
class DynamicView:
    """
    A dynamic view.
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    elementId: Optional[str] = None
    """
    The ID of the element this view is associated with (optional).
    """
    paperSize: Optional[PaperSize] = None
    """
    The paper size that should be used to render this view.
    """
    dimensions: Optional[Dimensions] = None
    automaticLayout: Optional[AutomaticLayout] = None
    elements: Optional[List[ElementView]] = None
    """
    The set of elements in this views.
    """
    relationships: Optional[List[RelationshipView]] = None
    """
    The set of relationships in this views.
    """
    externalBoundariesVisible: Optional[bool] = None
    """
    Specifies software system/container boundaries should be visible for "external" containers/components (those outside the element in scope)
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

elementId class-attribute instance-attribute

elementId: Optional[str] = None

The ID of the element this view is associated with (optional).

paperSize class-attribute instance-attribute

paperSize: Optional[PaperSize] = None

The paper size that should be used to render this view.

elements class-attribute instance-attribute

elements: Optional[List[ElementView]] = None

The set of elements in this views.

relationships class-attribute instance-attribute

relationships: Optional[List[RelationshipView]] = None

The set of relationships in this views.

externalBoundariesVisible class-attribute instance-attribute

externalBoundariesVisible: Optional[bool] = None

Specifies software system/container boundaries should be visible for “external” containers/components (those outside the element in scope)

DeploymentView dataclass

A deployment view.

Source code in buildzr/models/models.py

@dataclass
class DeploymentView:
    """
    A deployment view.
    """

    key: Optional[str] = None
    """
    A unique identifier for this view.
    """
    order: Optional[float] = None
    """
    An integer representing the creation order of this view.
    """
    title: Optional[str] = None
    """
    The title of this view (optional).
    """
    description: Optional[str] = None
    """
    The description of this view.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    softwareSystemId: Optional[str] = None
    """
    The ID of the software system this view is associated with (optional).
    """
    environment: Optional[str] = None
    """
    The name of the environment that this deployment view is for (e.g. "Development", "Live", etc).
    """
    paperSize: Optional[PaperSize] = None
    """
    The paper size that should be used to render this view.
    """
    dimensions: Optional[Dimensions] = None
    automaticLayout: Optional[AutomaticLayout] = None
    elements: Optional[List[ElementView]] = None
    """
    The set of elements in this views.
    """
    relationships: Optional[List[RelationshipView]] = None
    """
    The set of relationships in this views.
    """
    animations: Optional[List[AnimationStep]] = None
    """
    The set of animation steps (optional).
    """

key class-attribute instance-attribute

key: Optional[str] = None

A unique identifier for this view.

order class-attribute instance-attribute

order: Optional[float] = None

An integer representing the creation order of this view.

title class-attribute instance-attribute

title: Optional[str] = None

The title of this view (optional).

description class-attribute instance-attribute

description: Optional[str] = None

The description of this view.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

softwareSystemId class-attribute instance-attribute

softwareSystemId: Optional[str] = None

The ID of the software system this view is associated with (optional).

environment class-attribute instance-attribute

environment: Optional[str] = None

The name of the environment that this deployment view is for (e.g. “Development”, “Live”, etc).

paperSize class-attribute instance-attribute

paperSize: Optional[PaperSize] = None

The paper size that should be used to render this view.

elements class-attribute instance-attribute

elements: Optional[List[ElementView]] = None

The set of elements in this views.

relationships class-attribute instance-attribute

relationships: Optional[List[RelationshipView]] = None

The set of relationships in this views.

animations class-attribute instance-attribute

animations: Optional[List[AnimationStep]] = None

The set of animation steps (optional).

Container dataclass

A container (something that can execute code or host data).

Source code in buildzr/models/models.py

@dataclass
class Container:
    """
    A container (something that can execute code or host data).
    """

    id: Optional[str] = None
    """
    The ID of this container in the model.
    """
    name: Optional[str] = None
    """
    The name of this container.
    """
    description: Optional[str] = None
    """
    A short description of this container.
    """
    technology: Optional[str] = None
    """
    The technology associated with this container (e.g. Apache Tomcat).
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this container.
    """
    url: Optional[str] = None
    """
    The URL where more information about this element can be found.
    """
    components: Optional[List[Component]] = None
    """
    The set of components within this container.
    """
    group: Optional[str] = None
    """
    The name of the group in which this container should be included in.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this container to other elements.
    """
    documentation: Optional[Documentation] = None

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this container in the model.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this container.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of this container.

technology class-attribute instance-attribute

technology: Optional[str] = None

The technology associated with this container (e.g. Apache Tomcat).

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this container.

url class-attribute instance-attribute

url: Optional[str] = None

The URL where more information about this element can be found.

components class-attribute instance-attribute

components: Optional[List[Component]] = None

The set of components within this container.

group class-attribute instance-attribute

group: Optional[str] = None

The name of the group in which this container should be included in.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this container to other elements.

DeploymentNode dataclass

A deployment node.

Source code in buildzr/models/models.py

@dataclass
class DeploymentNode:
    """
    A deployment node.
    """

    id: Optional[str] = None
    """
    The ID of this deployment node in the model.
    """
    name: Optional[str] = None
    """
    The name of this deployment node.
    """
    description: Optional[str] = None
    """
    A short description of this deployment node.
    """
    technology: Optional[str] = None
    """
    The technology associated with this deployment node (e.g. Apache Tomcat).
    """
    environment: Optional[str] = None
    """
    The deployment environment in which this deployment node resides (e.g. "Development", "Live", etc).
    """
    instances: Optional[str] = None
    """
    The number of instances; either a number (e.g. 1, 2, etc) or a range (e.g. 0..N, 0..*, 1..3, etc).
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this deployment node.
    """
    url: Optional[str] = None
    """
    The URL where more information about this element can be found.
    """
    children: Optional[List[DeploymentNode]] = None
    """
    The set of child/nested deployment nodes.
    """
    infrastructureNodes: Optional[List[InfrastructureNode]] = None
    softwareSystemInstances: Optional[List[SoftwareSystemInstance]] = None
    """
    The set of software systems instances running in this deployment node..
    """
    containerInstances: Optional[List[ContainerInstance]] = None
    """
    The set of container instances running in this deployment node..
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this deployment node to other elements.
    """

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this deployment node in the model.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this deployment node.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of this deployment node.

technology class-attribute instance-attribute

technology: Optional[str] = None

The technology associated with this deployment node (e.g. Apache Tomcat).

environment class-attribute instance-attribute

environment: Optional[str] = None

The deployment environment in which this deployment node resides (e.g. “Development”, “Live”, etc).

instances class-attribute instance-attribute

instances: Optional[str] = None

The number of instances; either a number (e.g. 1, 2, etc) or a range (e.g. 0..N, 0..*, 1..3, etc).

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this deployment node.

url class-attribute instance-attribute

url: Optional[str] = None

The URL where more information about this element can be found.

children class-attribute instance-attribute

children: Optional[List[DeploymentNode]] = None

The set of child/nested deployment nodes.

softwareSystemInstances class-attribute instance-attribute

softwareSystemInstances: Optional[List[SoftwareSystemInstance]] = None

The set of software systems instances running in this deployment node..

containerInstances class-attribute instance-attribute

containerInstances: Optional[List[ContainerInstance]] = None

The set of container instances running in this deployment node..

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this deployment node to other elements.

Views dataclass

The set of views onto a software architecture model.

Source code in buildzr/models/models.py

@dataclass
class Views:
    """
    The set of views onto a software architecture model.
    """

    systemLandscapeViews: Optional[List[SystemLandscapeView]] = None
    """
    The set of system landscape views.
    """
    systemContextViews: Optional[List[SystemContextView]] = None
    """
    The set of system context views.
    """
    containerViews: Optional[List[ContainerView]] = None
    """
    The set of container views.
    """
    componentViews: Optional[List[ComponentView]] = None
    """
    The set of component views.
    """
    dynamicViews: Optional[List[DynamicView]] = None
    """
    The set of dynamic views.
    """
    deploymentViews: Optional[List[DeploymentView]] = None
    """
    The set of deployment views.
    """
    filteredViews: Optional[List[FilteredView]] = None
    """
    The set of filtered views.
    """
    imageViews: Optional[List[ImageView]] = None
    """
    The set of image views.
    """
    configuration: Optional[Configuration] = None

systemLandscapeViews class-attribute instance-attribute

systemLandscapeViews: Optional[List[SystemLandscapeView]] = None

The set of system landscape views.

systemContextViews class-attribute instance-attribute

systemContextViews: Optional[List[SystemContextView]] = None

The set of system context views.

containerViews class-attribute instance-attribute

containerViews: Optional[List[ContainerView]] = None

The set of container views.

componentViews class-attribute instance-attribute

componentViews: Optional[List[ComponentView]] = None

The set of component views.

dynamicViews class-attribute instance-attribute

dynamicViews: Optional[List[DynamicView]] = None

The set of dynamic views.

deploymentViews class-attribute instance-attribute

deploymentViews: Optional[List[DeploymentView]] = None

The set of deployment views.

filteredViews class-attribute instance-attribute

filteredViews: Optional[List[FilteredView]] = None

The set of filtered views.

imageViews class-attribute instance-attribute

imageViews: Optional[List[ImageView]] = None

The set of image views.

SoftwareSystem dataclass

A software system.

Source code in buildzr/models/models.py

@dataclass
class SoftwareSystem:
    """
    A software system.
    """

    id: Optional[str] = None
    """
    The ID of this software system in the model.
    """
    name: Optional[str] = None
    """
    The name of this software system.
    """
    description: Optional[str] = None
    """
    A short description of this software system.
    """
    location: Optional[Location1] = None
    """
    The location of this software system.
    """
    tags: Optional[str] = None
    """
    A comma separated list of tags associated with this software system.
    """
    url: Optional[str] = None
    """
    The URL where more information about this element can be found.
    """
    containers: Optional[List[Container]] = None
    """
    The set of containers within this software system.
    """
    group: Optional[str] = None
    """
    The name of the group in which this software system should be included in.
    """
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """
    perspectives: Optional[List[Perspective]] = None
    """
    The set of perspectives associated with this element.
    """
    relationships: Optional[List[Relationship]] = None
    """
    The set of relationships from this software system to other elements.
    """
    documentation: Optional[Documentation] = None

id class-attribute instance-attribute

id: Optional[str] = None

The ID of this software system in the model.

name class-attribute instance-attribute

name: Optional[str] = None

The name of this software system.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of this software system.

location class-attribute instance-attribute

location: Optional[Location1] = None

The location of this software system.

tags class-attribute instance-attribute

tags: Optional[str] = None

A comma separated list of tags associated with this software system.

url class-attribute instance-attribute

url: Optional[str] = None

The URL where more information about this element can be found.

containers class-attribute instance-attribute

containers: Optional[List[Container]] = None

The set of containers within this software system.

group class-attribute instance-attribute

group: Optional[str] = None

The name of the group in which this software system should be included in.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

perspectives class-attribute instance-attribute

perspectives: Optional[List[Perspective]] = None

The set of perspectives associated with this element.

relationships class-attribute instance-attribute

relationships: Optional[List[Relationship]] = None

The set of relationships from this software system to other elements.

Model dataclass

A software architecture model.

Source code in buildzr/models/models.py

@dataclass
class Model:
    """
    A software architecture model.
    """

    enterprise: Optional[Enterprise] = None
    """
    The enterprise associated with this model.
    """
    people: Optional[List[Person]] = None
    softwareSystems: Optional[List[SoftwareSystem]] = None
    deploymentNodes: Optional[List[DeploymentNode]] = None
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """

enterprise class-attribute instance-attribute

enterprise: Optional[Enterprise] = None

The enterprise associated with this model.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

Workspace dataclass

Represents a Structurizr workspace, which is a wrapper for a software architecture model, views, and documentation.

Source code in buildzr/models/models.py

@dataclass
class Workspace:
    """
    Represents a Structurizr workspace, which is a wrapper for a software architecture model, views, and documentation.
    """

    id: Optional[int] = None
    """
    The workspace ID.
    """
    name: Optional[str] = None
    """
    The name of the workspace.
    """
    description: Optional[str] = None
    """
    A short description of the workspace.
    """
    version: Optional[str] = None
    """
    A version number for the workspace.
    """
    thumbnail: Optional[str] = None
    """
    The thumbnail associated with the workspace; a Base64 encoded PNG file as a data URI (data:image/png;base64).
    """
    lastModifiedDate: Optional[str] = None
    """
    The last modified date, in ISO 8601 format (e.g. "2018-09-08T12:40:03Z").
    """
    lastModifiedUser: Optional[str] = None
    """
    A string identifying the user who last modified the workspace (e.g. an e-mail address or username).
    """
    lastModifiedAgent: Optional[str] = None
    """
    A string identifying the agent that was last used to modify the workspace (e.g. "structurizr-java/1.2.0").
    """
    model: Optional[Model] = None
    views: Optional[Views] = None
    documentation: Optional[Documentation] = None
    configuration: Optional[WorkspaceConfiguration] = None
    properties: Optional[Dict[str, Any]] = None
    """
    A set of arbitrary name-value properties.
    """

id class-attribute instance-attribute

id: Optional[int] = None

The workspace ID.

name class-attribute instance-attribute

name: Optional[str] = None

The name of the workspace.

description class-attribute instance-attribute

description: Optional[str] = None

A short description of the workspace.

version class-attribute instance-attribute

version: Optional[str] = None

A version number for the workspace.

thumbnail class-attribute instance-attribute

thumbnail: Optional[str] = None

The thumbnail associated with the workspace; a Base64 encoded PNG file as a data URI (data:image/png;base64).

lastModifiedDate class-attribute instance-attribute

lastModifiedDate: Optional[str] = None

The last modified date, in ISO 8601 format (e.g. “2018-09-08T12:40:03Z”).

lastModifiedUser class-attribute instance-attribute

lastModifiedUser: Optional[str] = None

A string identifying the user who last modified the workspace (e.g. an e-mail address or username).

lastModifiedAgent class-attribute instance-attribute

lastModifiedAgent: Optional[str] = None

A string identifying the agent that was last used to modify the workspace (e.g. “structurizr-java/1.2.0”).

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

A set of arbitrary name-value properties.

Overview

The buildzr.models module contains Pydantic models generated from the Structurizr JSON schema using datamodel-code-generator.

When to Use

Most users should use the higher-level DSL API (buildzr.dsl) rather than working directly with these models. However, these models are useful when:

1. Direct JSON manipulation - Converting between Python objects and JSON
2. Custom extensions - Building custom functionality on top of buildzr
3. Integration - Integrating with other Structurizr tools
4. Validation - Validating Structurizr JSON structures

Key Model Classes

Workspace Model

The root model representing a complete Structurizr workspace.

from buildzr.models import Workspace, Model, ViewSet

workspace = Workspace(
    name="My Workspace",
    model=Model(),
    views=ViewSet()
)

Model Elements

Core model element types:

• Person - Human users/actors
• SoftwareSystem - Software systems
• Container - Applications/data stores
• Component - Components within containers

Deployment Model Elements

Deployment-related model types:

• DeploymentNode - Infrastructure nodes (servers, cloud instances, etc.)
• InfrastructureNode - Supporting infrastructure (load balancers, message queues, etc.)
• ContainerInstance - Deployed instance of a container
• SoftwareSystemInstance - Deployed instance of a software system

Relationships

from buildzr.models import Relationship

relationship = Relationship(
    sourceId="1",
    destinationId="2",
    description="Uses",
    technology="HTTPS"
)

Views

View models for different diagram types:

• SystemLandscapeView
• SystemContextView
• ContainerView
• ComponentView
• DeploymentView

Working with Models

Exporting to JSON

workspace_dict = workspace.dict(exclude_none=True, by_alias=True)

with open('output.json', 'w') as f:
    json.dump(workspace_dict, f, indent=2)

Type Hints

All models include full type hints for IDE support:

from buildzr.models import Workspace, Model

def process_workspace(ws: Workspace) -> Model:
    return ws.model

Schema Compliance

These models are auto-generated to stay in sync with the official Structurizr JSON schema, ensuring compatibility with all Structurizr tools.

Complete Example with Deployment

Here’s a more comprehensive example that includes deployment models:

import json
from buildzr.models import (
    Workspace,
    Model,
    ViewSet,
    Person,
    SoftwareSystem,
    Container,
    DeploymentNode,
    ContainerInstance,
    InfrastructureNode,
    Relationship,
    SystemContextView,
    DeploymentView,
)

# Create a workspace
workspace = Workspace(
    name="Complete Example",
    description="Example with deployment models",
    model=Model(
        people=[
            Person(
                id="1",
                name="User",
                description="System user"
            )
        ],
        softwareSystems=[
            SoftwareSystem(
                id="2",
                name="Web Application",
                containers=[
                    Container(
                        id="3",
                        name="API",
                        technology="Python/FastAPI"
                    ),
                    Container(
                        id="4",
                        name="Database",
                        technology="PostgreSQL"
                    )
                ]
            )
        ],
        relationships=[
            Relationship(
                sourceId="1",
                destinationId="2",
                description="Uses"
            ),
            Relationship(
                sourceId="3",
                destinationId="4",
                description="Reads from and writes to",
                technology="SQL"
            )
        ]
    ),
    views=ViewSet(
        systemContextViews=[
            SystemContextView(
                key="context",
                softwareSystemId="2",
                description="System Context"
            )
        ],
        deploymentViews=[
            DeploymentView(
                key="deployment",
                softwareSystemId="2",
                environment="Production",
                description="Production Deployment"
            )
        ]
    )
)

# Add deployment model
deployment_node_aws = DeploymentNode(
    id="5",
    name="AWS",
    technology="Cloud Provider",
    children=[
        DeploymentNode(
            id="6",
            name="ECS Cluster",
            technology="Container Service",
            containerInstances=[
                ContainerInstance(
                    id="7",
                    containerId="3",
                    instanceId=1
                )
            ]
        ),
        DeploymentNode(
            id="8",
            name="RDS",
            technology="Managed Database",
            containerInstances=[
                ContainerInstance(
                    id="9",
                    containerId="4",
                    instanceId=1
                )
            ]
        )
    ],
    infrastructureNodes=[
        InfrastructureNode(
            id="10",
            name="Load Balancer",
            technology="AWS ALB"
        )
    ]
)

# Add deployment environment to model
if not workspace.model.deploymentNodes:
    workspace.model.deploymentNodes = []
workspace.model.deploymentNodes.append(deployment_node_aws)

# Export to JSON
workspace_dict = workspace.dict(exclude_none=True, by_alias=True)
with open('complete_workspace.json', 'w') as f:
    json.dump(workspace_dict, f, indent=2)

print("Workspace created with deployment models!")

DSL vs Models

While you can use the low-level models directly as shown above, most users should prefer the higher-level DSL API from buildzr.dsl, which provides a more intuitive and Pythonic interface.

Model IDs

When working directly with models, you need to manually manage element IDs and references. The DSL API handles this automatically.

See Also

• DSL API Reference - High-level DSL API (recommended)
• Structurizr JSON Schema - Official schema
• User Guide - Usage guide