Skip to content

docs(lb): fix ACL match field description #1117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 25, 2025
Merged

docs(lb): fix ACL match field description #1117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions scaleway-async/scaleway_async/lb/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1527,7 +1527,7 @@ async def create_frontend(
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param name: Name for the frontend.
:param timeout_client: Maximum allowed inactivity time on the client side.
Expand Down Expand Up @@ -1635,7 +1635,7 @@ async def update_frontend(
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:return: :class:`Frontend <Frontend>`

Usage:
Expand Down Expand Up @@ -2168,7 +2168,7 @@ async def create_acl(
:param description: ACL description.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param name: ACL name.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:return: :class:`Acl <Acl>`

Usage:
Expand Down Expand Up @@ -2256,7 +2256,7 @@ async def update_acl(
:param action: Action to take when incoming traffic matches an ACL filter.
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:param description: ACL description.
:return: :class:`Acl <Acl>`

Expand Down Expand Up @@ -4574,7 +4574,7 @@ async def create_frontend(
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name for the frontend.
:param timeout_client: Maximum allowed inactivity time on the client side.
Expand Down Expand Up @@ -4684,7 +4684,7 @@ async def update_frontend(
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:return: :class:`Frontend <Frontend>`

Usage:
Expand Down Expand Up @@ -5225,7 +5225,7 @@ async def create_acl(
:param description: ACL description.
:param region: Region to target. If none is passed will use default region from the config.
:param name: ACL name.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:return: :class:`Acl <Acl>`

Usage:
Expand Down Expand Up @@ -5315,7 +5315,7 @@ async def update_acl(
:param action: Action to take when incoming traffic matches an ACL filter.
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
:param region: Region to target. If none is passed will use default region from the config.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:param description: ACL description.
:return: :class:`Acl <Acl>`

Expand Down
22 changes: 11 additions & 11 deletions scaleway-async/scaleway_async/lb/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -936,7 +936,7 @@ class Frontend:

enable_access_logs: bool
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""

certificate: Optional[Certificate]
Expand Down Expand Up @@ -1070,7 +1070,7 @@ class Acl:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""

action: Optional[AclAction]
Expand Down Expand Up @@ -1218,7 +1218,7 @@ class AclSpec:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` and `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` and `http_filter_value` are required.
"""


Expand Down Expand Up @@ -1307,7 +1307,7 @@ class CreateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""


Expand Down Expand Up @@ -1475,7 +1475,7 @@ class CreateFrontendRequest:

enable_access_logs: bool
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""

region: Optional[ScwRegion]
Expand Down Expand Up @@ -2530,7 +2530,7 @@ class UpdateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""

description: Optional[str]
Expand Down Expand Up @@ -2719,7 +2719,7 @@ class UpdateFrontendRequest:

enable_access_logs: Optional[bool]
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""


Expand Down Expand Up @@ -2971,7 +2971,7 @@ class ZonedApiCreateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""


Expand Down Expand Up @@ -3139,7 +3139,7 @@ class ZonedApiCreateFrontendRequest:

enable_access_logs: bool
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""

zone: Optional[ScwZone]
Expand Down Expand Up @@ -4048,7 +4048,7 @@ class ZonedApiUpdateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""

description: Optional[str]
Expand Down Expand Up @@ -4237,7 +4237,7 @@ class ZonedApiUpdateFrontendRequest:

enable_access_logs: Optional[bool]
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""


Expand Down
16 changes: 8 additions & 8 deletions scaleway/scaleway/lb/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1527,7 +1527,7 @@ def create_frontend(
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param name: Name for the frontend.
:param timeout_client: Maximum allowed inactivity time on the client side.
Expand Down Expand Up @@ -1635,7 +1635,7 @@ def update_frontend(
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:return: :class:`Frontend <Frontend>`

Usage:
Expand Down Expand Up @@ -2168,7 +2168,7 @@ def create_acl(
:param description: ACL description.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param name: ACL name.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:return: :class:`Acl <Acl>`

Usage:
Expand Down Expand Up @@ -2256,7 +2256,7 @@ def update_acl(
:param action: Action to take when incoming traffic matches an ACL filter.
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:param description: ACL description.
:return: :class:`Acl <Acl>`

Expand Down Expand Up @@ -4572,7 +4572,7 @@ def create_frontend(
:param lb_id: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
:param backend_id: Backend ID (ID of the backend the frontend should pass traffic to).
:param enable_http3: Defines whether to enable HTTP/3 protocol on the frontend.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name for the frontend.
:param timeout_client: Maximum allowed inactivity time on the client side.
Expand Down Expand Up @@ -4682,7 +4682,7 @@ def update_frontend(
:param certificate_id: Certificate ID, deprecated in favor of certificate_ids array.
:param certificate_ids: List of SSL/TLS certificate IDs to bind to the frontend.
:param connection_rate_limit: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
:param enable_access_logs: Defines wether to enable access logs on the frontend.
:param enable_access_logs: Defines whether to enable access logs on the frontend.
:return: :class:`Frontend <Frontend>`

Usage:
Expand Down Expand Up @@ -5223,7 +5223,7 @@ def create_acl(
:param description: ACL description.
:param region: Region to target. If none is passed will use default region from the config.
:param name: ACL name.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:return: :class:`Acl <Acl>`

Usage:
Expand Down Expand Up @@ -5313,7 +5313,7 @@ def update_acl(
:param action: Action to take when incoming traffic matches an ACL filter.
:param index: Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
:param region: Region to target. If none is passed will use default region from the config.
:param match: ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
:param match: ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
:param description: ACL description.
:return: :class:`Acl <Acl>`

Expand Down
22 changes: 11 additions & 11 deletions scaleway/scaleway/lb/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -936,7 +936,7 @@ class Frontend:

enable_access_logs: bool
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""

certificate: Optional[Certificate]
Expand Down Expand Up @@ -1070,7 +1070,7 @@ class Acl:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""

action: Optional[AclAction]
Expand Down Expand Up @@ -1218,7 +1218,7 @@ class AclSpec:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` and `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` and `http_filter_value` are required.
"""


Expand Down Expand Up @@ -1307,7 +1307,7 @@ class CreateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""


Expand Down Expand Up @@ -1475,7 +1475,7 @@ class CreateFrontendRequest:

enable_access_logs: bool
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""

region: Optional[ScwRegion]
Expand Down Expand Up @@ -2530,7 +2530,7 @@ class UpdateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""

description: Optional[str]
Expand Down Expand Up @@ -2719,7 +2719,7 @@ class UpdateFrontendRequest:

enable_access_logs: Optional[bool]
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""


Expand Down Expand Up @@ -2971,7 +2971,7 @@ class ZonedApiCreateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""


Expand Down Expand Up @@ -3139,7 +3139,7 @@ class ZonedApiCreateFrontendRequest:

enable_access_logs: bool
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""

zone: Optional[ScwZone]
Expand Down Expand Up @@ -4048,7 +4048,7 @@ class ZonedApiUpdateAclRequest:

match: Optional[AclMatch]
"""
ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
ACL match filter object. One of `ip_subnet`, `ips_edge_services` or `http_filter` & `http_filter_value` are required.
"""

description: Optional[str]
Expand Down Expand Up @@ -4237,7 +4237,7 @@ class ZonedApiUpdateFrontendRequest:

enable_access_logs: Optional[bool]
"""
Defines wether to enable access logs on the frontend.
Defines whether to enable access logs on the frontend.
"""


Expand Down
Loading