Skip to content

Commit 5f98957

Browse files
Merge pull request #97 from Traceableai/add-ex
updated docs
2 parents 6368a77 + b12411d commit 5f98957

6 files changed

+135
-13
lines changed

docs/resources/data_classification_overrides.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,27 @@ description: |-
88

99
# traceable_data_classification_overrides (Resource)
1010

11-
12-
13-
11+
# Example
12+
```
13+
resource "traceable_data_classification_overrides" "example_override" {
14+
name = "example_override"
15+
description = "This is an example override for data classification"
16+
data_suppression_override = "REDACT"
17+
environments = []
18+
19+
span_filter {
20+
key_patterns {
21+
operator = "MATCHES_REGEX"
22+
value = ".*example.*"
23+
}
24+
25+
value_patterns {
26+
operator = "EQUALS"
27+
value = "sensitive"
28+
}
29+
}
30+
}
31+
```
1432

1533
<!-- schema generated by tfplugindocs -->
1634
## Schema

docs/resources/data_classification_rule.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,34 @@ description: |-
88

99
# traceable_data_classification_rule (Resource)
1010

11-
11+
# Example
12+
```
13+
resource "traceable_data_classification_rule" "example_data_classification" {
14+
name = "example_data_classification"
15+
description = "This is an example data classification rule"
16+
enabled = true
17+
data_sets = ["dataset-1"]
18+
data_suppression = "REDACT"
19+
sensitivity = "HIGH"
20+
21+
scoped_patterns {
22+
scoped_pattern_name = "example_pattern"
23+
environments = []
24+
match_type = "MATCH"
25+
locations = ["REQUEST_BODY"]
26+
27+
key_patterns {
28+
operator = "MATCHES_REGEX"
29+
value = ".*example.*"
30+
}
31+
32+
value_patterns {
33+
operator = "EQUALS"
34+
value = "sensitive"
35+
}
36+
}
37+
}
38+
```
1239

1340

1441

docs/resources/data_sets.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@ description: |-
88

99
# traceable_data_sets (Resource)
1010

11-
12-
13-
11+
# Example
12+
```
13+
resource "traceable_data_sets" "example_data_set" {
14+
name = "example_data_set"
15+
description = "This is an example data set"
16+
icon_type = "Financial"
17+
}
18+
```
1419

1520
<!-- schema generated by tfplugindocs -->
1621
## Schema

docs/resources/detection_policies.md

+25
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,31 @@ description: |-
88

99
# traceable_detection_policies (Resource)
1010
<!-- schema generated by tfplugindocs -->
11+
# Example
12+
```
13+
resource "traceable_detection_policies" "sample_rule" {
14+
environment = "env"
15+
waap_config {
16+
rule_id = "XSS"
17+
rule_config {
18+
disabled = false
19+
}
20+
}
21+
}
22+
23+
# subrule_config case
24+
resource "traceable_detection_policies" "sample_rule" {
25+
environment = "utkarsh_crapi"
26+
waap_config {
27+
rule_id = "XSS"
28+
subrule_config {
29+
sub_rule_id = "crs_941280"
30+
sub_rule_action = "MONITOR"
31+
}
32+
}
33+
}
34+
```
35+
1136
## Schema
1237

1338
### Required

docs/resources/label_management_label.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@ description: |-
88

99
# traceable_label_management_label (Resource)
1010

11-
12-
13-
11+
# Example
12+
```
13+
resource "traceable_label_creation_rule" "example_label_create_rule" {
14+
name="test-rule-create-label-test1"
15+
description="test rule to create a label"
16+
color="#E295E9"
17+
}
18+
```
1419

1520
<!-- schema generated by tfplugindocs -->
1621
## Schema

docs/resources/label_management_label_rule.md

+45-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,51 @@ description: |-
88

99
# traceable_label_management_label_rule (Resource)
1010

11-
12-
13-
11+
# Example
12+
```
13+
# For Static Labels
14+
resource "traceable_label_management_label_rule" "example_label_rule_static" {
15+
name = "example_label_rule_static"
16+
description = "This is an example label rule"
17+
enabled = true
18+
19+
condition_list {
20+
key = "http.method"
21+
operator = "OPERATOR_EQUALS"
22+
value = "POST"
23+
}
24+
25+
action {
26+
type = "STATIC_LABELS"
27+
entity_types = ["API", "SERVICE", "BACKEND"]
28+
operation = "OPERATION_MERGE"
29+
static_labels = ["Sensitive"]
30+
}
31+
}
32+
33+
# For Dynamic Labels
34+
resource "traceable_label_management_label_rule" "example_label_rule_dynamic" {
35+
name = "example_label_rule_dynamic"
36+
description = "This is an example label rule"
37+
enabled = true
38+
39+
condition_list {
40+
key = "http.method"
41+
operator = "OPERATOR_EQUALS"
42+
value = "POST"
43+
}
44+
45+
action {
46+
type = "DYNAMIC_LABEL"
47+
entity_types = ["API", "SERVICE", "BACKEND"]
48+
operation = "OPERATION_MERGE"
49+
dynamic_labels {
50+
attribute = "http.enduser.id"
51+
regex = "abcd123(.*)"
52+
}
53+
}
54+
}
55+
```
1456

1557
<!-- schema generated by tfplugindocs -->
1658
## Schema

0 commit comments

Comments
 (0)