Skip to main content

Get the currently defined model as svg uml image.

GET 
/graph/:graph_id/model/uml

Get the currently defined model as svg uml image.

Request​

Path Parameters

    graph_id stringrequired

    The identifier of the graph

    Example: fix

Query Parameters

    output string

    Possible values: [svg, png, puml]

    Default value: svg

    The output format.

    show string

    comma separated list of resources to show. Entries can be regexps.

    Example: aws_ec2_instance,gcp.*
    hide string

    comma separated list of resources to hide. Entries can be regexps. hide takes precedence over show.

    Example: aws_ec2_instance,gcp.*
    with_inheritance boolean

    Default value: true

    Include inheritance relations in the model.

    with_base_classes boolean

    Default value: true

    Include all base classes of visible entries

    with_subclasses boolean

    Include all descendant classes of visible entries

    dependency string

    comma separated list of dependency relationships.

    Example: default
    with_predecessors boolean

    Include all predecessors of selected entries

    with_successors boolean

    Include all successors of selected entries

    with_properties any

    Show properties of selected entries

    link_classes boolean

    Add anchor links to classes.

    aggregate_roots boolean

    Default value: true

    Show aggregate roots.

    sort_props boolean

    Default value: true

    Sort properties by name.

Responses​

Returns the model as uml diagram in svg format

Loading...
Last updated