Skip to content

Commit f271a4b

Browse files
chore(api): update composite API spec
1 parent b129315 commit f271a4b

9 files changed

Lines changed: 217 additions & 81 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 1802
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-e581e5f97f2de43098da4d30544af20d8a4bcd418981435b48ee862c14317273.yml
3-
openapi_spec_hash: 04daf40bd8b3e63b6caa81de24e765dc
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-9deae24d13b0c6ab1dee39ca28bfcc3075482843b369d47510976bd2e7c33172.yml
3+
openapi_spec_hash: b494277f0af559cde1530dde36a00371
44
config_hash: 7f7d0989caf43ee0fc1a934907e4db8a

src/cloudflare/resources/zero_trust/gateway/rules.py

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ def create(
109109
110110
expiration: Defines the expiration time stamp and default duration of a DNS policy. Takes
111111
precedence over the policy's `schedule` configuration, if any. This does not
112-
apply to HTTP or network policies.
112+
apply to HTTP or network policies. Settable only for `dns` rules.
113113
114114
filters: Specify the protocol or layer to evaluate the traffic, identity, and device
115115
posture expressions.
@@ -125,10 +125,15 @@ def create(
125125
[Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform)
126126
to manage precedence via Terraform.
127127
128-
rule_settings: Set settings related to this rule.
128+
rule_settings: Set settings related to this rule. Each setting is only valid for specific rule
129+
types and can only be used with the appropriate selectors. If Terraform drift is
130+
observed in these setting values, verify that the setting is supported for the
131+
given rule type and that the API response reflects the requested value. If the
132+
API response returns sanitized or modified values that differ from the request,
133+
use the API-provided values in Terraform to ensure consistency.
129134
130-
schedule: Defines the schedule for activating DNS policies. (HTTP/Egress or L4
131-
unsupported).
135+
schedule: Defines the schedule for activating DNS policies. Settable only for `dns` and
136+
`dns_resolver` rules.
132137
133138
traffic: Specify the wirefilter expression used for traffic matching. The API
134139
automatically formats and sanitizes expressions before storing them. To prevent
@@ -237,7 +242,7 @@ def update(
237242
238243
expiration: Defines the expiration time stamp and default duration of a DNS policy. Takes
239244
precedence over the policy's `schedule` configuration, if any. This does not
240-
apply to HTTP or network policies.
245+
apply to HTTP or network policies. Settable only for `dns` rules.
241246
242247
filters: Specify the protocol or layer to evaluate the traffic, identity, and device
243248
posture expressions.
@@ -253,10 +258,15 @@ def update(
253258
[Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform)
254259
to manage precedence via Terraform.
255260
256-
rule_settings: Set settings related to this rule.
261+
rule_settings: Set settings related to this rule. Each setting is only valid for specific rule
262+
types and can only be used with the appropriate selectors. If Terraform drift is
263+
observed in these setting values, verify that the setting is supported for the
264+
given rule type and that the API response reflects the requested value. If the
265+
API response returns sanitized or modified values that differ from the request,
266+
use the API-provided values in Terraform to ensure consistency.
257267
258-
schedule: Defines the schedule for activating DNS policies. (HTTP/Egress or L4
259-
unsupported).
268+
schedule: Defines the schedule for activating DNS policies. Settable only for `dns` and
269+
`dns_resolver` rules.
260270
261271
traffic: Specify the wirefilter expression used for traffic matching. The API
262272
automatically formats and sanitizes expressions before storing them. To prevent
@@ -547,7 +557,7 @@ async def create(
547557
548558
expiration: Defines the expiration time stamp and default duration of a DNS policy. Takes
549559
precedence over the policy's `schedule` configuration, if any. This does not
550-
apply to HTTP or network policies.
560+
apply to HTTP or network policies. Settable only for `dns` rules.
551561
552562
filters: Specify the protocol or layer to evaluate the traffic, identity, and device
553563
posture expressions.
@@ -563,10 +573,15 @@ async def create(
563573
[Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform)
564574
to manage precedence via Terraform.
565575
566-
rule_settings: Set settings related to this rule.
576+
rule_settings: Set settings related to this rule. Each setting is only valid for specific rule
577+
types and can only be used with the appropriate selectors. If Terraform drift is
578+
observed in these setting values, verify that the setting is supported for the
579+
given rule type and that the API response reflects the requested value. If the
580+
API response returns sanitized or modified values that differ from the request,
581+
use the API-provided values in Terraform to ensure consistency.
567582
568-
schedule: Defines the schedule for activating DNS policies. (HTTP/Egress or L4
569-
unsupported).
583+
schedule: Defines the schedule for activating DNS policies. Settable only for `dns` and
584+
`dns_resolver` rules.
570585
571586
traffic: Specify the wirefilter expression used for traffic matching. The API
572587
automatically formats and sanitizes expressions before storing them. To prevent
@@ -675,7 +690,7 @@ async def update(
675690
676691
expiration: Defines the expiration time stamp and default duration of a DNS policy. Takes
677692
precedence over the policy's `schedule` configuration, if any. This does not
678-
apply to HTTP or network policies.
693+
apply to HTTP or network policies. Settable only for `dns` rules.
679694
680695
filters: Specify the protocol or layer to evaluate the traffic, identity, and device
681696
posture expressions.
@@ -691,10 +706,15 @@ async def update(
691706
[Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform)
692707
to manage precedence via Terraform.
693708
694-
rule_settings: Set settings related to this rule.
709+
rule_settings: Set settings related to this rule. Each setting is only valid for specific rule
710+
types and can only be used with the appropriate selectors. If Terraform drift is
711+
observed in these setting values, verify that the setting is supported for the
712+
given rule type and that the API response reflects the requested value. If the
713+
API response returns sanitized or modified values that differ from the request,
714+
use the API-provided values in Terraform to ensure consistency.
695715
696-
schedule: Defines the schedule for activating DNS policies. (HTTP/Egress or L4
697-
unsupported).
716+
schedule: Defines the schedule for activating DNS policies. Settable only for `dns` and
717+
`dns_resolver` rules.
698718
699719
traffic: Specify the wirefilter expression used for traffic matching. The API
700720
automatically formats and sanitizes expressions before storing them. To prevent

src/cloudflare/types/zero_trust/gateway/gateway_configuration_settings.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,14 @@ class GatewayConfigurationSettings(BaseModel):
8080
"""
8181

8282
extended_email_matching: Optional[ExtendedEmailMatching] = None
83-
"""Specify user emails settings for the firewall policies."""
83+
"""Specify user email settings for the firewall policies.
84+
85+
When this is enabled, we standardize the email addresses in the identity part of
86+
the rule, so that they match the extended email variants in the firewall
87+
policies. When this setting is turned off, the email addresses in the identity
88+
part of the rule will be matched exactly as provided. If your email has `.` or
89+
`+` modifiers, you should enable this setting.
90+
"""
8491

8592
fips: Optional[FipsSettings] = None
8693
"""Specify FIPS settings."""

src/cloudflare/types/zero_trust/gateway/gateway_configuration_settings_param.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,14 @@ class GatewayConfigurationSettingsParam(TypedDict, total=False):
8181
"""
8282

8383
extended_email_matching: Optional[ExtendedEmailMatchingParam]
84-
"""Specify user emails settings for the firewall policies."""
84+
"""Specify user email settings for the firewall policies.
85+
86+
When this is enabled, we standardize the email addresses in the identity part of
87+
the rule, so that they match the extended email variants in the firewall
88+
policies. When this setting is turned off, the email addresses in the identity
89+
part of the rule will be matched exactly as provided. If your email has `.` or
90+
`+` modifiers, you should enable this setting.
91+
"""
8592

8693
fips: Optional[FipsSettingsParam]
8794
"""Specify FIPS settings."""

src/cloudflare/types/zero_trust/gateway/gateway_rule.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class GatewayRule(BaseModel):
108108
"""Defines the expiration time stamp and default duration of a DNS policy.
109109
110110
Takes precedence over the policy's `schedule` configuration, if any. This does
111-
not apply to HTTP or network policies.
111+
not apply to HTTP or network policies. Settable only for `dns` rules.
112112
"""
113113

114114
identity: Optional[str] = None
@@ -123,12 +123,20 @@ class GatewayRule(BaseModel):
123123
"""Indicate that this rule is shared via the Orgs API and read only."""
124124

125125
rule_settings: Optional[RuleSetting] = None
126-
"""Set settings related to this rule."""
126+
"""Set settings related to this rule.
127+
128+
Each setting is only valid for specific rule types and can only be used with the
129+
appropriate selectors. If Terraform drift is observed in these setting values,
130+
verify that the setting is supported for the given rule type and that the API
131+
response reflects the requested value. If the API response returns sanitized or
132+
modified values that differ from the request, use the API-provided values in
133+
Terraform to ensure consistency.
134+
"""
127135

128136
schedule: Optional[Schedule] = None
129137
"""Defines the schedule for activating DNS policies.
130138
131-
(HTTP/Egress or L4 unsupported).
139+
Settable only for `dns` and `dns_resolver` rules.
132140
"""
133141

134142
sharable: Optional[bool] = None

src/cloudflare/types/zero_trust/gateway/rule_create_params.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ class RuleCreateParams(TypedDict, total=False):
6363
"""Defines the expiration time stamp and default duration of a DNS policy.
6464
6565
Takes precedence over the policy's `schedule` configuration, if any. This does
66-
not apply to HTTP or network policies.
66+
not apply to HTTP or network policies. Settable only for `dns` rules.
6767
"""
6868

6969
filters: List[GatewayFilter]
@@ -90,12 +90,20 @@ class RuleCreateParams(TypedDict, total=False):
9090
"""
9191

9292
rule_settings: RuleSettingParam
93-
"""Set settings related to this rule."""
93+
"""Set settings related to this rule.
94+
95+
Each setting is only valid for specific rule types and can only be used with the
96+
appropriate selectors. If Terraform drift is observed in these setting values,
97+
verify that the setting is supported for the given rule type and that the API
98+
response reflects the requested value. If the API response returns sanitized or
99+
modified values that differ from the request, use the API-provided values in
100+
Terraform to ensure consistency.
101+
"""
94102

95103
schedule: Optional[ScheduleParam]
96104
"""Defines the schedule for activating DNS policies.
97105
98-
(HTTP/Egress or L4 unsupported).
106+
Settable only for `dns` and `dns_resolver` rules.
99107
"""
100108

101109
traffic: str

0 commit comments

Comments
 (0)