PsMermaidTools

PowerShell Module to create Mermaid diagrams.

View the Project on GitHub abbgrade/PsMermaidTools

Add-MermaidC4Relation

SYNOPSIS

Add a relation to a diagram.

SYNTAX

Add-MermaidC4Relation -Diagram <Object> [-From] <String> [-To] <String> [-Label] <String>
 [-Technology <String>] [-Description <String>] [<CommonParameters>]

DESCRIPTION

Create a relation between two components and add it to an C4 diagram.

EXAMPLES

Example 1

PS C:\> 

PARAMETERS

-Diagram

The diagram, that the relation is added to.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-From

The first entity of the relation.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-To

The second entity of the relation.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Label

Describes the relationship.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Technology

The relation technology / implementation.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Describes the relation.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

C4 diagram object.

OUTPUTS

None.

NOTES

https://abbgrade.github.io/PsMermaidTools/docs/Add-MermaidC4Relation.html

https://mermaid.js.org/syntax/c4c.html#c4-component-diagram-c4component