Skip to content

Commit d4dc4c4

Browse files
authored
docs(lb): fix ACL match field description (#1117)
1 parent 2e8457e commit d4dc4c4

File tree

4 files changed

+38
-38
lines changed

4 files changed

+38
-38
lines changed

scaleway-async/scaleway_async/lb/v1/api.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1527,7 +1527,7 @@ async def create_frontend(
15271527
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
15281528
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
15291529
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
1530-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
1530+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
15311531
:param zone: Zone to target. If none is passed will use default zone from the config.
15321532
:param name: Name for the frontend.
15331533
:param timeout_client: Maximum allowed inactivity time on the client side.
@@ -1635,7 +1635,7 @@ async def update_frontend(
16351635
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
16361636
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
16371637
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
1638-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
1638+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
16391639
:return: :class:`Frontend <Frontend>`
16401640
16411641
Usage:
@@ -2168,7 +2168,7 @@ async def create_acl(
21682168
:param description: ACL description.
21692169
:param zone: Zone to target. If none is passed will use default zone from the config.
21702170
:param name: ACL name.
2171-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2171+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
21722172
:return: :class:`Acl <Acl>`
21732173
21742174
Usage:
@@ -2256,7 +2256,7 @@ async def update_acl(
22562256
:param action: Action to take when incoming traffic matches an ACL filter.
22572257
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
22582258
:param zone: Zone to target. If none is passed will use default zone from the config.
2259-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2259+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
22602260
:param description: ACL description.
22612261
:return: :class:`Acl <Acl>`
22622262
@@ -4574,7 +4574,7 @@ async def create_frontend(
45744574
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
45754575
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
45764576
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
4577-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
4577+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
45784578
:param region: Region to target. If none is passed will use default region from the config.
45794579
:param name: Name for the frontend.
45804580
:param timeout_client: Maximum allowed inactivity time on the client side.
@@ -4684,7 +4684,7 @@ async def update_frontend(
46844684
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
46854685
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
46864686
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
4687-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
4687+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
46884688
:return: :class:`Frontend <Frontend>`
46894689
46904690
Usage:
@@ -5225,7 +5225,7 @@ async def create_acl(
52255225
:param description: ACL description.
52265226
:param region: Region to target. If none is passed will use default region from the config.
52275227
:param name: ACL name.
5228-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
5228+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
52295229
:return: :class:`Acl <Acl>`
52305230
52315231
Usage:
@@ -5315,7 +5315,7 @@ async def update_acl(
53155315
:param action: Action to take when incoming traffic matches an ACL filter.
53165316
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
53175317
:param region: Region to target. If none is passed will use default region from the config.
5318-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
5318+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
53195319
:param description: ACL description.
53205320
:return: :class:`Acl <Acl>`
53215321

scaleway-async/scaleway_async/lb/v1/types.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -936,7 +936,7 @@ class Frontend:
936936

937937
enable_access_logs: bool
938938
"""
939-
Defines wether to enable access logs on the frontend.
939+
Defines whether to enable access logs on the frontend.
940940
"""
941941

942942
certificate: Optional[Certificate]
@@ -1070,7 +1070,7 @@ class Acl:
10701070

10711071
match: Optional[AclMatch]
10721072
"""
1073-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
1073+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
10741074
"""
10751075

10761076
action: Optional[AclAction]
@@ -1218,7 +1218,7 @@ class AclSpec:
12181218

12191219
match: Optional[AclMatch]
12201220
"""
1221-
ACL match filter object. One of `ip_subnet` or `http_filter` and `http_filter_value` are required.
1221+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` and `http_filter_value` are required.
12221222
"""
12231223

12241224

@@ -1307,7 +1307,7 @@ class CreateAclRequest:
13071307

13081308
match: Optional[AclMatch]
13091309
"""
1310-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
1310+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
13111311
"""
13121312

13131313

@@ -1475,7 +1475,7 @@ class CreateFrontendRequest:
14751475

14761476
enable_access_logs: bool
14771477
"""
1478-
Defines wether to enable access logs on the frontend.
1478+
Defines whether to enable access logs on the frontend.
14791479
"""
14801480

14811481
region: Optional[ScwRegion]
@@ -2530,7 +2530,7 @@ class UpdateAclRequest:
25302530

25312531
match: Optional[AclMatch]
25322532
"""
2533-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2533+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
25342534
"""
25352535

25362536
description: Optional[str]
@@ -2719,7 +2719,7 @@ class UpdateFrontendRequest:
27192719

27202720
enable_access_logs: Optional[bool]
27212721
"""
2722-
Defines wether to enable access logs on the frontend.
2722+
Defines whether to enable access logs on the frontend.
27232723
"""
27242724

27252725

@@ -2971,7 +2971,7 @@ class ZonedApiCreateAclRequest:
29712971

29722972
match: Optional[AclMatch]
29732973
"""
2974-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2974+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
29752975
"""
29762976

29772977

@@ -3139,7 +3139,7 @@ class ZonedApiCreateFrontendRequest:
31393139

31403140
enable_access_logs: bool
31413141
"""
3142-
Defines wether to enable access logs on the frontend.
3142+
Defines whether to enable access logs on the frontend.
31433143
"""
31443144

31453145
zone: Optional[ScwZone]
@@ -4048,7 +4048,7 @@ class ZonedApiUpdateAclRequest:
40484048

40494049
match: Optional[AclMatch]
40504050
"""
4051-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
4051+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
40524052
"""
40534053

40544054
description: Optional[str]
@@ -4237,7 +4237,7 @@ class ZonedApiUpdateFrontendRequest:
42374237

42384238
enable_access_logs: Optional[bool]
42394239
"""
4240-
Defines wether to enable access logs on the frontend.
4240+
Defines whether to enable access logs on the frontend.
42414241
"""
42424242

42434243

scaleway/scaleway/lb/v1/api.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1527,7 +1527,7 @@ def create_frontend(
15271527
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
15281528
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
15291529
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
1530-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
1530+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
15311531
:param zone: Zone to target. If none is passed will use default zone from the config.
15321532
:param name: Name for the frontend.
15331533
:param timeout_client: Maximum allowed inactivity time on the client side.
@@ -1635,7 +1635,7 @@ def update_frontend(
16351635
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
16361636
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
16371637
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
1638-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
1638+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
16391639
:return: :class:`Frontend <Frontend>`
16401640
16411641
Usage:
@@ -2168,7 +2168,7 @@ def create_acl(
21682168
:param description: ACL description.
21692169
:param zone: Zone to target. If none is passed will use default zone from the config.
21702170
:param name: ACL name.
2171-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2171+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
21722172
:return: :class:`Acl <Acl>`
21732173
21742174
Usage:
@@ -2256,7 +2256,7 @@ def update_acl(
22562256
:param action: Action to take when incoming traffic matches an ACL filter.
22572257
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
22582258
:param zone: Zone to target. If none is passed will use default zone from the config.
2259-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2259+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
22602260
:param description: ACL description.
22612261
:return: :class:`Acl <Acl>`
22622262
@@ -4572,7 +4572,7 @@ def create_frontend(
45724572
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
45734573
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
45744574
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
4575-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
4575+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
45764576
:param region: Region to target. If none is passed will use default region from the config.
45774577
:param name: Name for the frontend.
45784578
:param timeout_client: Maximum allowed inactivity time on the client side.
@@ -4682,7 +4682,7 @@ def update_frontend(
46824682
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
46834683
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
46844684
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
4685-
:param enable_access_logs: Defines wether to enable access logs on the frontend.
4685+
:param enable_access_logs: Defines whether to enable access logs on the frontend.
46864686
:return: :class:`Frontend <Frontend>`
46874687
46884688
Usage:
@@ -5223,7 +5223,7 @@ def create_acl(
52235223
:param description: ACL description.
52245224
:param region: Region to target. If none is passed will use default region from the config.
52255225
:param name: ACL name.
5226-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
5226+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
52275227
:return: :class:`Acl <Acl>`
52285228
52295229
Usage:
@@ -5313,7 +5313,7 @@ def update_acl(
53135313
:param action: Action to take when incoming traffic matches an ACL filter.
53145314
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
53155315
:param region: Region to target. If none is passed will use default region from the config.
5316-
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
5316+
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
53175317
:param description: ACL description.
53185318
:return: :class:`Acl <Acl>`
53195319

scaleway/scaleway/lb/v1/types.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -936,7 +936,7 @@ class Frontend:
936936

937937
enable_access_logs: bool
938938
"""
939-
Defines wether to enable access logs on the frontend.
939+
Defines whether to enable access logs on the frontend.
940940
"""
941941

942942
certificate: Optional[Certificate]
@@ -1070,7 +1070,7 @@ class Acl:
10701070

10711071
match: Optional[AclMatch]
10721072
"""
1073-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
1073+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
10741074
"""
10751075

10761076
action: Optional[AclAction]
@@ -1218,7 +1218,7 @@ class AclSpec:
12181218

12191219
match: Optional[AclMatch]
12201220
"""
1221-
ACL match filter object. One of `ip_subnet` or `http_filter` and `http_filter_value` are required.
1221+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` and `http_filter_value` are required.
12221222
"""
12231223

12241224

@@ -1307,7 +1307,7 @@ class CreateAclRequest:
13071307

13081308
match: Optional[AclMatch]
13091309
"""
1310-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
1310+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
13111311
"""
13121312

13131313

@@ -1475,7 +1475,7 @@ class CreateFrontendRequest:
14751475

14761476
enable_access_logs: bool
14771477
"""
1478-
Defines wether to enable access logs on the frontend.
1478+
Defines whether to enable access logs on the frontend.
14791479
"""
14801480

14811481
region: Optional[ScwRegion]
@@ -2530,7 +2530,7 @@ class UpdateAclRequest:
25302530

25312531
match: Optional[AclMatch]
25322532
"""
2533-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2533+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
25342534
"""
25352535

25362536
description: Optional[str]
@@ -2719,7 +2719,7 @@ class UpdateFrontendRequest:
27192719

27202720
enable_access_logs: Optional[bool]
27212721
"""
2722-
Defines wether to enable access logs on the frontend.
2722+
Defines whether to enable access logs on the frontend.
27232723
"""
27242724

27252725

@@ -2971,7 +2971,7 @@ class ZonedApiCreateAclRequest:
29712971

29722972
match: Optional[AclMatch]
29732973
"""
2974-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
2974+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
29752975
"""
29762976

29772977

@@ -3139,7 +3139,7 @@ class ZonedApiCreateFrontendRequest:
31393139

31403140
enable_access_logs: bool
31413141
"""
3142-
Defines wether to enable access logs on the frontend.
3142+
Defines whether to enable access logs on the frontend.
31433143
"""
31443144

31453145
zone: Optional[ScwZone]
@@ -4048,7 +4048,7 @@ class ZonedApiUpdateAclRequest:
40484048

40494049
match: Optional[AclMatch]
40504050
"""
4051-
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
4051+
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
40524052
"""
40534053

40544054
description: Optional[str]
@@ -4237,7 +4237,7 @@ class ZonedApiUpdateFrontendRequest:
42374237

42384238
enable_access_logs: Optional[bool]
42394239
"""
4240-
Defines wether to enable access logs on the frontend.
4240+
Defines whether to enable access logs on the frontend.
42414241
"""
42424242

42434243

0 commit comments

Comments
 (0)