Skip to content

Commit 94e3a2f

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent f79ce8c commit 94e3a2f

File tree

11 files changed

+187
-158
lines changed

11 files changed

+187
-158
lines changed

‎.stats.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 1711
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-9a240855cda6dbdadcc3935ef47d6a78e5b1967e8bc324815efcb5a87122cdbc.yml
3-
openapi_spec_hash: a765ed4748e49fc0a5eddd9d6df0bbca
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-3c1d17582f816c7386d64d80a7b3b6b6d2642cd4d4a9d1838aa98bb764280953.yml
3+
openapi_spec_hash: c75c95aa5b99d2c3ff5a49b8c11547ea
44
config_hash: 501967dbe66b4bf5bcf0d508ebdc37c3

‎src/cloudflare/resources/firewall/waf/packages/groups.py

+42-40
Original file line numberDiff line numberDiff line change
@@ -75,27 +75,28 @@ def list(
7575
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
7676
7777
Args:
78-
zone_id: Identifier
78+
zone_id: Defines an identifier of a schema.
7979
80-
package_id: The unique identifier of a WAF package.
80+
package_id: Defines the unique identifier of a WAF package.
8181
82-
direction: The direction used to sort returned rule groups.
82+
direction: Defines the direction used to sort returned rule groups.
8383
84-
match: When set to `all`, all the search requirements must match. When set to `any`,
85-
only one of the search requirements has to match.
84+
match: Defines the condition for search requirements. When set to `all`, all the search
85+
requirements must match. When set to `any`, only one of the search requirements
86+
has to match.
8687
87-
mode: The state of the rules contained in the rule group. When `on`, the rules in the
88-
group are configurable/usable.
88+
mode: Defines the state of the rules contained in the rule group. When `on`, the rules
89+
in the group are configurable/usable.
8990
90-
name: The name of the rule group.
91+
name: Defines the name of the rule group.
9192
92-
order: The field used to sort returned rule groups.
93+
order: Defines the field used to sort returned rule groups.
9394
94-
page: The page number of paginated results.
95+
page: Defines the page number of paginated results.
9596
96-
per_page: The number of rule groups per page.
97+
per_page: Defines the number of rule groups per page.
9798
98-
rules_count: The number of rules in the current rule group.
99+
rules_count: Defines the number of rules in the current rule group.
99100
100101
extra_headers: Send extra headers
101102
@@ -157,14 +158,14 @@ def edit(
157158
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
158159
159160
Args:
160-
zone_id: Identifier
161+
zone_id: Defines an identifier of a schema.
161162
162-
package_id: The unique identifier of a WAF package.
163+
package_id: Defines the unique identifier of a WAF package.
163164
164-
group_id: The unique identifier of a WAF package.
165+
group_id: Defines the unique identifier of a WAF package.
165166
166-
mode: The state of the rules contained in the rule group. When `on`, the rules in the
167-
group are configurable/usable.
167+
mode: Defines the state of the rules contained in the rule group. When `on`, the rules
168+
in the group are configurable/usable.
168169
169170
extra_headers: Send extra headers
170171
@@ -218,11 +219,11 @@ def get(
218219
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
219220
220221
Args:
221-
zone_id: Identifier
222+
zone_id: Defines an identifier of a schema.
222223
223-
package_id: The unique identifier of a WAF package.
224+
package_id: Defines the unique identifier of a WAF package.
224225
225-
group_id: The unique identifier of a WAF package.
226+
group_id: Defines the unique identifier of a WAF package.
226227
227228
extra_headers: Send extra headers
228229
@@ -303,27 +304,28 @@ def list(
303304
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
304305
305306
Args:
306-
zone_id: Identifier
307+
zone_id: Defines an identifier of a schema.
307308
308-
package_id: The unique identifier of a WAF package.
309+
package_id: Defines the unique identifier of a WAF package.
309310
310-
direction: The direction used to sort returned rule groups.
311+
direction: Defines the direction used to sort returned rule groups.
311312
312-
match: When set to `all`, all the search requirements must match. When set to `any`,
313-
only one of the search requirements has to match.
313+
match: Defines the condition for search requirements. When set to `all`, all the search
314+
requirements must match. When set to `any`, only one of the search requirements
315+
has to match.
314316
315-
mode: The state of the rules contained in the rule group. When `on`, the rules in the
316-
group are configurable/usable.
317+
mode: Defines the state of the rules contained in the rule group. When `on`, the rules
318+
in the group are configurable/usable.
317319
318-
name: The name of the rule group.
320+
name: Defines the name of the rule group.
319321
320-
order: The field used to sort returned rule groups.
322+
order: Defines the field used to sort returned rule groups.
321323
322-
page: The page number of paginated results.
324+
page: Defines the page number of paginated results.
323325
324-
per_page: The number of rule groups per page.
326+
per_page: Defines the number of rule groups per page.
325327
326-
rules_count: The number of rules in the current rule group.
328+
rules_count: Defines the number of rules in the current rule group.
327329
328330
extra_headers: Send extra headers
329331
@@ -385,14 +387,14 @@ async def edit(
385387
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
386388
387389
Args:
388-
zone_id: Identifier
390+
zone_id: Defines an identifier of a schema.
389391
390-
package_id: The unique identifier of a WAF package.
392+
package_id: Defines the unique identifier of a WAF package.
391393
392-
group_id: The unique identifier of a WAF package.
394+
group_id: Defines the unique identifier of a WAF package.
393395
394-
mode: The state of the rules contained in the rule group. When `on`, the rules in the
395-
group are configurable/usable.
396+
mode: Defines the state of the rules contained in the rule group. When `on`, the rules
397+
in the group are configurable/usable.
396398
397399
extra_headers: Send extra headers
398400
@@ -446,11 +448,11 @@ async def get(
446448
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
447449
448450
Args:
449-
zone_id: Identifier
451+
zone_id: Defines an identifier of a schema.
450452
451-
package_id: The unique identifier of a WAF package.
453+
package_id: Defines the unique identifier of a WAF package.
452454
453-
group_id: The unique identifier of a WAF package.
455+
group_id: Defines the unique identifier of a WAF package.
454456
455457
extra_headers: Send extra headers
456458

‎src/cloudflare/resources/firewall/waf/packages/rules.py

+42-40
Original file line numberDiff line numberDiff line change
@@ -76,28 +76,29 @@ def list(
7676
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
7777
7878
Args:
79-
zone_id: Identifier
79+
zone_id: Defines an identifier of a schema.
8080
81-
package_id: The unique identifier of a WAF package.
81+
package_id: Defines the unique identifier of a WAF package.
8282
83-
description: The public description of the WAF rule.
83+
description: Defines the public description of the WAF rule.
8484
85-
direction: The direction used to sort returned rules.
85+
direction: Defines the direction used to sort returned rules.
8686
87-
group_id: The unique identifier of the rule group.
87+
group_id: Defines the unique identifier of the rule group.
8888
89-
match: When set to `all`, all the search requirements must match. When set to `any`,
90-
only one of the search requirements has to match.
89+
match: Defines the search requirements. When set to `all`, all the search requirements
90+
must match. When set to `any`, only one of the search requirements has to match.
9191
92-
mode: The action/mode a rule has been overridden to perform.
92+
mode: Defines the action/mode a rule has been overridden to perform.
9393
94-
order: The field used to sort returned rules.
94+
order: Defines the field used to sort returned rules.
9595
96-
page: The page number of paginated results.
96+
page: Defines the page number of paginated results.
9797
98-
per_page: The number of rules per page.
98+
per_page: Defines the number of rules per page.
9999
100-
priority: The order in which the individual WAF rule is executed within its rule group.
100+
priority: Defines the order in which the individual WAF rule is executed within its rule
101+
group.
101102
102103
extra_headers: Send extra headers
103104
@@ -159,14 +160,14 @@ def edit(
159160
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
160161
161162
Args:
162-
zone_id: Identifier
163+
zone_id: Defines an identifier of a schema.
163164
164-
package_id: The unique identifier of a WAF package.
165+
package_id: Defines the unique identifier of a WAF package.
165166
166-
rule_id: The unique identifier of a WAF package.
167+
rule_id: Defines the unique identifier of a WAF package.
167168
168-
mode: The mode/action of the rule when triggered. You must use a value from the
169-
`allowed_modes` array of the current rule.
169+
mode: Defines the mode/action of the rule when triggered. You must use a value from
170+
the `allowed_modes` array of the current rule.
170171
171172
extra_headers: Send extra headers
172173
@@ -220,11 +221,11 @@ def get(
220221
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
221222
222223
Args:
223-
zone_id: Identifier
224+
zone_id: Defines an identifier of a schema.
224225
225-
package_id: The unique identifier of a WAF package.
226+
package_id: Defines the unique identifier of a WAF package.
226227
227-
rule_id: The unique identifier of a WAF package.
228+
rule_id: Defines the unique identifier of a WAF package.
228229
229230
extra_headers: Send extra headers
230231
@@ -306,28 +307,29 @@ def list(
306307
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
307308
308309
Args:
309-
zone_id: Identifier
310+
zone_id: Defines an identifier of a schema.
310311
311-
package_id: The unique identifier of a WAF package.
312+
package_id: Defines the unique identifier of a WAF package.
312313
313-
description: The public description of the WAF rule.
314+
description: Defines the public description of the WAF rule.
314315
315-
direction: The direction used to sort returned rules.
316+
direction: Defines the direction used to sort returned rules.
316317
317-
group_id: The unique identifier of the rule group.
318+
group_id: Defines the unique identifier of the rule group.
318319
319-
match: When set to `all`, all the search requirements must match. When set to `any`,
320-
only one of the search requirements has to match.
320+
match: Defines the search requirements. When set to `all`, all the search requirements
321+
must match. When set to `any`, only one of the search requirements has to match.
321322
322-
mode: The action/mode a rule has been overridden to perform.
323+
mode: Defines the action/mode a rule has been overridden to perform.
323324
324-
order: The field used to sort returned rules.
325+
order: Defines the field used to sort returned rules.
325326
326-
page: The page number of paginated results.
327+
page: Defines the page number of paginated results.
327328
328-
per_page: The number of rules per page.
329+
per_page: Defines the number of rules per page.
329330
330-
priority: The order in which the individual WAF rule is executed within its rule group.
331+
priority: Defines the order in which the individual WAF rule is executed within its rule
332+
group.
331333
332334
extra_headers: Send extra headers
333335
@@ -389,14 +391,14 @@ async def edit(
389391
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
390392
391393
Args:
392-
zone_id: Identifier
394+
zone_id: Defines an identifier of a schema.
393395
394-
package_id: The unique identifier of a WAF package.
396+
package_id: Defines the unique identifier of a WAF package.
395397
396-
rule_id: The unique identifier of a WAF package.
398+
rule_id: Defines the unique identifier of a WAF package.
397399
398-
mode: The mode/action of the rule when triggered. You must use a value from the
399-
`allowed_modes` array of the current rule.
400+
mode: Defines the mode/action of the rule when triggered. You must use a value from
401+
the `allowed_modes` array of the current rule.
400402
401403
extra_headers: Send extra headers
402404
@@ -450,11 +452,11 @@ async def get(
450452
[previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
451453
452454
Args:
453-
zone_id: Identifier
455+
zone_id: Defines an identifier of a schema.
454456
455-
package_id: The unique identifier of a WAF package.
457+
package_id: Defines the unique identifier of a WAF package.
456458
457-
rule_id: The unique identifier of a WAF package.
459+
rule_id: Defines the unique identifier of a WAF package.
458460
459461
extra_headers: Send extra headers
460462

‎src/cloudflare/types/firewall/waf/packages/group.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,31 @@
1010

1111
class Group(BaseModel):
1212
id: str
13-
"""The unique identifier of the rule group."""
13+
"""Defines the unique identifier of the rule group."""
1414

1515
description: Optional[str] = None
16-
"""An informative summary of what the rule group does."""
16+
"""Defines an informative summary of what the rule group does."""
1717

1818
mode: Literal["on", "off"]
19-
"""The state of the rules contained in the rule group.
19+
"""Defines the state of the rules contained in the rule group.
2020
2121
When `on`, the rules in the group are configurable/usable.
2222
"""
2323

2424
name: str
25-
"""The name of the rule group."""
25+
"""Defines the name of the rule group."""
2626

2727
rules_count: float
28-
"""The number of rules in the current rule group."""
28+
"""Defines the number of rules in the current rule group."""
2929

3030
allowed_modes: Optional[List[Literal["on", "off"]]] = None
31-
"""The available states for the rule group."""
31+
"""Defines the available states for the rule group."""
3232

3333
modified_rules_count: Optional[float] = None
3434
"""
35-
The number of rules within the group that have been modified from their default
36-
configuration.
35+
Defines the number of rules within the group that have been modified from their
36+
default configuration.
3737
"""
3838

3939
package_id: Optional[str] = None
40-
"""The unique identifier of a WAF package."""
40+
"""Defines the unique identifier of a WAF package."""

‎src/cloudflare/types/firewall/waf/packages/group_edit_params.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99

1010
class GroupEditParams(TypedDict, total=False):
1111
zone_id: Required[str]
12-
"""Identifier"""
12+
"""Defines an identifier of a schema."""
1313

1414
package_id: Required[str]
15-
"""The unique identifier of a WAF package."""
15+
"""Defines the unique identifier of a WAF package."""
1616

1717
mode: Literal["on", "off"]
18-
"""The state of the rules contained in the rule group.
18+
"""Defines the state of the rules contained in the rule group.
1919
2020
When `on`, the rules in the group are configurable/usable.
2121
"""

0 commit comments

Comments
 (0)