Skip to content

chore: remove nat from documentation #844

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
Feb 3, 2025
Merged

chore: remove nat from documentation #844

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
8 changes: 4 additions & 4 deletions scaleway-async/scaleway_async/instance/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3445,7 +3445,7 @@ async def list_ips(
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
:param page: A positive integer to choose the page to return.
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
:return: :class:`ListIpsResponse <ListIpsResponse>`

Usage:
Expand Down Expand Up @@ -3495,7 +3495,7 @@ async def list_ips_all(
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
:param page: A positive integer to choose the page to return.
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
:return: :class:`List[Ip] <List[Ip]>`

Usage:
Expand Down Expand Up @@ -3540,7 +3540,7 @@ async def create_ip(
One-Of ('project_identifier'): at most one of 'project', 'organization' could be set.
:param tags: Tags of the IP.
:param server: UUID of the Instance you want to attach the IP to.
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
:return: :class:`CreateIpResponse <CreateIpResponse>`

Usage:
Expand Down Expand Up @@ -3618,7 +3618,7 @@ async def update_ip(
:param ip: IP ID or IP address.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param reverse: Reverse domain name.
:param type_: Convert a 'nat' IP to a 'routed_ipv4'.
:param type_: Should have no effect.
:param tags: An array of keywords you want to tag this IP with.
:param server:
:return: :class:`UpdateIpResponse <UpdateIpResponse>`
Expand Down
7 changes: 3 additions & 4 deletions scaleway-async/scaleway_async/instance/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ def __str__(self) -> str:

class IpType(str, Enum, metaclass=StrEnumMeta):
UNKNOWN_IPTYPE = "unknown_iptype"
NAT = "nat"
ROUTED_IPV4 = "routed_ipv4"
ROUTED_IPV6 = "routed_ipv6"

Expand Down Expand Up @@ -1579,7 +1578,7 @@ class CreateIpRequest:

type_: Optional[IpType]
"""
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
"""

project: Optional[str]
Expand Down Expand Up @@ -2444,7 +2443,7 @@ class ListIpsRequest:

type_: Optional[str]
"""
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
"""


Expand Down Expand Up @@ -3180,7 +3179,7 @@ class UpdateIpRequest:

type_: Optional[IpType]
"""
Convert a 'nat' IP to a 'routed_ipv4'.
Should have no effect.
"""

tags: Optional[List[str]]
Expand Down
8 changes: 4 additions & 4 deletions scaleway/scaleway/instance/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3445,7 +3445,7 @@ def list_ips(
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
:param page: A positive integer to choose the page to return.
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
:return: :class:`ListIpsResponse <ListIpsResponse>`

Usage:
Expand Down Expand Up @@ -3495,7 +3495,7 @@ def list_ips_all(
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
:param page: A positive integer to choose the page to return.
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
:param type_: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
:return: :class:`List[Ip] <List[Ip]>`

Usage:
Expand Down Expand Up @@ -3540,7 +3540,7 @@ def create_ip(
One-Of ('project_identifier'): at most one of 'project', 'organization' could be set.
:param tags: Tags of the IP.
:param server: UUID of the Instance you want to attach the IP to.
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
:param type_: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
:return: :class:`CreateIpResponse <CreateIpResponse>`

Usage:
Expand Down Expand Up @@ -3618,7 +3618,7 @@ def update_ip(
:param ip: IP ID or IP address.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param reverse: Reverse domain name.
:param type_: Convert a 'nat' IP to a 'routed_ipv4'.
:param type_: Should have no effect.
:param tags: An array of keywords you want to tag this IP with.
:param server:
:return: :class:`UpdateIpResponse <UpdateIpResponse>`
Expand Down
7 changes: 3 additions & 4 deletions scaleway/scaleway/instance/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ def __str__(self) -> str:

class IpType(str, Enum, metaclass=StrEnumMeta):
UNKNOWN_IPTYPE = "unknown_iptype"
NAT = "nat"
ROUTED_IPV4 = "routed_ipv4"
ROUTED_IPV6 = "routed_ipv6"

Expand Down Expand Up @@ -1579,7 +1578,7 @@ class CreateIpRequest:

type_: Optional[IpType]
"""
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated).
IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
"""

project: Optional[str]
Expand Down Expand Up @@ -2444,7 +2443,7 @@ class ListIpsRequest:

type_: Optional[str]
"""
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').
Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
"""


Expand Down Expand Up @@ -3180,7 +3179,7 @@ class UpdateIpRequest:

type_: Optional[IpType]
"""
Convert a 'nat' IP to a 'routed_ipv4'.
Should have no effect.
"""

tags: Optional[List[str]]
Expand Down