You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/aggregation-property.md
+19-16Lines changed: 19 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -908,6 +908,9 @@ The `pathFilter` option lets you control which entities are included in your agg
908
908
909
909
When a `pathFilter` is defined, Port will include only entities that can be reached through the exact relationship path you specify.
910
910
911
+
-**Forwards path**: Following relations forwards, from the source of a relation to its target (e.g., from a repository to its services)
912
+
-**Backwards path**: Following relations backwards, from the target of a relation to its source (e.g., from a service back to its repository)
913
+
911
914
<h4> Structure </h4>
912
915
913
916
| Field | Description |
@@ -916,7 +919,7 @@ When a `pathFilter` is defined, Port will include only entities that can be reac
916
919
|`pathFilter.fromBlueprint`|*(Optional)* The blueprint to start the path traversal from. Can be the target blueprint or omitted. If omitted, traversal starts from the source blueprint. |
917
920
918
921
919
-
<h4> For upstream paths </h4>
922
+
<h4> For forwards paths </h4>
920
923
921
924
```json showLineNumbers
922
925
{
@@ -928,7 +931,7 @@ When a `pathFilter` is defined, Port will include only entities that can be reac
928
931
}
929
932
```
930
933
931
-
<h4> For downstream paths </h4>
934
+
<h4> For backwards paths </h4>
932
935
933
936
```json showLineNumbers
934
937
{
@@ -955,7 +958,7 @@ Suppose you have the following data model:
955
958
956
959
<TabItemvalue="api">
957
960
958
-
<h4>Example 1: Standard Path Filter</h4>
961
+
<h4>Example 1: Standard Path Filter - forwards path</h4>
959
962
960
963
Count how many deployments are directly related to a cluster:
961
964
@@ -969,7 +972,7 @@ Count how many deployments are directly related to a cluster:
969
972
"target": "deployment",
970
973
"pathFilter": [
971
974
{
972
-
"path": ["deployments_rel"]
975
+
"path": ["deployments_relation"]
973
976
}
974
977
],
975
978
"calculationSpec": {
@@ -981,9 +984,9 @@ Count how many deployments are directly related to a cluster:
981
984
}
982
985
```
983
986
984
-
The `pathFilter` with `"path": ["deployments_rel"]` counts deployments that are directly related to the cluster through the `deployments_rel` relation.
987
+
The `pathFilter` with `"path": ["deployments_relation"]` counts deployments that are directly related to the cluster through the `deployments_relation` relation.
985
988
986
-
<h4>Example 2: Using fromBlueprint</h4>
989
+
<h4>Example 2: Using fromBlueprint - backwards path</h4>
987
990
988
991
Count how many clusters are related to a deployment:
989
992
@@ -997,7 +1000,7 @@ Count how many clusters are related to a deployment:
997
1000
"target": "cluster",
998
1001
"pathFilter": [
999
1002
{
1000
-
"path": ["deployments_rel"],
1003
+
"path": ["deployments_relation"],
1001
1004
"fromBlueprint": "cluster"
1002
1005
}
1003
1006
],
@@ -1010,13 +1013,13 @@ Count how many clusters are related to a deployment:
1010
1013
}
1011
1014
```
1012
1015
1013
-
The `fromBlueprint: "cluster"` specifies that the path traversal should start from the cluster blueprint (the target), then follow the path backwards through `deployments_rel` to deployment.
1016
+
The `fromBlueprint: "cluster"` specifies that the path traversal should start from the cluster blueprint (the target), then follow the path backwards through `deployments_relation` to deployment.
1014
1017
1015
1018
</TabItem>
1016
1019
1017
1020
<TabItemvalue="tf">
1018
1021
1019
-
<h4>Example 1: Standard Path Filter</h4>
1022
+
<h4>Example 1: Standard Path Filter - forwards path</h4>
1020
1023
1021
1024
Count how many deployments are directly related to a cluster:
The `from_blueprint = "cluster"` specifies that the path traversal should start from the cluster blueprint (the target), then follow the path backwards through `deployments_rel` to deployment.
1109
+
The `from_blueprint = "cluster"` specifies that the path traversal should start from the cluster blueprint (the target), then follow the path backwards through `deployments_relation` to deployment.
0 commit comments