Skip to content

Commit 461ac37

Browse files
authored
chore: remove nat from documentation (scaleway#844)
1 parent fdfe7aa commit 461ac37

File tree

4 files changed

+14
-16
lines changed

4 files changed

+14
-16
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3445,7 +3445,7 @@ async def list_ips(
34453445
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
34463446
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
34473447
:param page: A positive integer to choose the page to return.
3448-
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
3448+
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
34493449
:return: :class:`ListIpsResponse <ListIpsResponse>`
34503450
34513451
Usage:
@@ -3495,7 +3495,7 @@ async def list_ips_all(
34953495
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
34963496
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
34973497
:param page: A positive integer to choose the page to return.
3498-
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
3498+
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
34993499
:return: :class:`List[Ip] <List[Ip]>`
35003500
35013501
Usage:
@@ -3540,7 +3540,7 @@ async def create_ip(
35403540
One-Of ('project_identifier'): at most one of 'project', 'organization' could be set.
35413541
:param tags: Tags of the IP.
35423542
:param server: UUID of the Instance you want to attach the IP to.
3543-
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
3543+
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
35443544
:return: :class:`CreateIpResponse <CreateIpResponse>`
35453545
35463546
Usage:
@@ -3618,7 +3618,7 @@ async def update_ip(
36183618
:param ip: IP ID or IP address.
36193619
:param zone: Zone to target. If none is passed will use default zone from the config.
36203620
:param reverse: Reverse domain name.
3621-
:param type_: Convert a 'nat' IP to a 'routed_ipv4'.
3621+
:param type_: Should have no effect.
36223622
:param tags: An array of keywords you want to tag this IP with.
36233623
:param server:
36243624
:return: :class:`UpdateIpResponse <UpdateIpResponse>`

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ def __str__(self) -> str:
6666

6767
class IpType(str, Enum, metaclass=StrEnumMeta):
6868
UNKNOWN_IPTYPE = "unknown_iptype"
69-
NAT = "nat"
7069
ROUTED_IPV4 = "routed_ipv4"
7170
ROUTED_IPV6 = "routed_ipv6"
7271

@@ -1579,7 +1578,7 @@ class CreateIpRequest:
15791578

15801579
type_: Optional[IpType]
15811580
"""
1582-
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
1581+
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
15831582
"""
15841583

15851584
project: Optional[str]
@@ -2444,7 +2443,7 @@ class ListIpsRequest:
24442443

24452444
type_: Optional[str]
24462445
"""
2447-
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
2446+
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
24482447
"""
24492448

24502449

@@ -3180,7 +3179,7 @@ class UpdateIpRequest:
31803179

31813180
type_: Optional[IpType]
31823181
"""
3183-
Convert a 'nat' IP to a 'routed_ipv4'.
3182+
Should have no effect.
31843183
"""
31853184

31863185
tags: Optional[List[str]]

scaleway/scaleway/instance/v1/api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3445,7 +3445,7 @@ def list_ips(
34453445
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
34463446
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
34473447
:param page: A positive integer to choose the page to return.
3448-
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
3448+
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
34493449
:return: :class:`ListIpsResponse <ListIpsResponse>`
34503450
34513451
Usage:
@@ -3495,7 +3495,7 @@ def list_ips_all(
34953495
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
34963496
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
34973497
:param page: A positive integer to choose the page to return.
3498-
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
3498+
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
34993499
:return: :class:`List[Ip] <List[Ip]>`
35003500
35013501
Usage:
@@ -3540,7 +3540,7 @@ def create_ip(
35403540
One-Of ('project_identifier'): at most one of 'project', 'organization' could be set.
35413541
:param tags: Tags of the IP.
35423542
:param server: UUID of the Instance you want to attach the IP to.
3543-
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
3543+
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
35443544
:return: :class:`CreateIpResponse <CreateIpResponse>`
35453545
35463546
Usage:
@@ -3618,7 +3618,7 @@ def update_ip(
36183618
:param ip: IP ID or IP address.
36193619
:param zone: Zone to target. If none is passed will use default zone from the config.
36203620
:param reverse: Reverse domain name.
3621-
:param type_: Convert a 'nat' IP to a 'routed_ipv4'.
3621+
:param type_: Should have no effect.
36223622
:param tags: An array of keywords you want to tag this IP with.
36233623
:param server:
36243624
:return: :class:`UpdateIpResponse <UpdateIpResponse>`

scaleway/scaleway/instance/v1/types.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ def __str__(self) -> str:
6666

6767
class IpType(str, Enum, metaclass=StrEnumMeta):
6868
UNKNOWN_IPTYPE = "unknown_iptype"
69-
NAT = "nat"
7069
ROUTED_IPV4 = "routed_ipv4"
7170
ROUTED_IPV6 = "routed_ipv6"
7271

@@ -1579,7 +1578,7 @@ class CreateIpRequest:
15791578

15801579
type_: Optional[IpType]
15811580
"""
1582-
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
1581+
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
15831582
"""
15841583

15851584
project: Optional[str]
@@ -2444,7 +2443,7 @@ class ListIpsRequest:
24442443

24452444
type_: Optional[str]
24462445
"""
2447-
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
2446+
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
24482447
"""
24492448

24502449

@@ -3180,7 +3179,7 @@ class UpdateIpRequest:
31803179

31813180
type_: Optional[IpType]
31823181
"""
3183-
Convert a 'nat' IP to a 'routed_ipv4'.
3182+
Should have no effect.
31843183
"""
31853184

31863185
tags: Optional[List[str]]

0 commit comments

Comments
 (0)