Skip to content

Commit bbbefbf

Browse files
docs(ipam): specify private IPs in description (scaleway#1679)
Co-authored-by: Mia-Cross <lmarabese@scaleway.com>
1 parent 4d4a51e commit bbbefbf

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

  • scaleway-async/scaleway_async/ipam/v1
  • scaleway/scaleway/ipam/v1

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -447,8 +447,8 @@ async def attach_ip(
447447
region: Optional[ScwRegion] = None,
448448
) -> IP:
449449
"""
450-
Attach IP to custom resource.
451-
Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
450+
Attach private IP to custom resource.
451+
Attach an existing reserved private IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
452452
:param ip_id: IP ID.
453453
:param resource: Custom resource to be attached to the IP.
454454
:param region: Region to target. If none is passed will use default region from the config.
@@ -492,7 +492,7 @@ async def detach_ip(
492492
region: Optional[ScwRegion] = None,
493493
) -> IP:
494494
"""
495-
Detach IP from a custom resource.
495+
Detach private IP from a custom resource.
496496
Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
497497
:param ip_id: IP ID.
498498
:param resource: Custom resource currently attached to the IP.
@@ -538,7 +538,7 @@ async def move_ip(
538538
to_resource: Optional[CustomResource] = None,
539539
) -> IP:
540540
"""
541-
Move IP to a custom resource.
541+
Move private IP to a custom resource.
542542
Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
543543
:param ip_id: IP ID.
544544
:param from_resource: Custom resource currently attached to the IP.

scaleway/scaleway/ipam/v1/api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -447,8 +447,8 @@ def attach_ip(
447447
region: Optional[ScwRegion] = None,
448448
) -> IP:
449449
"""
450-
Attach IP to custom resource.
451-
Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
450+
Attach private IP to custom resource.
451+
Attach an existing reserved private IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
452452
:param ip_id: IP ID.
453453
:param resource: Custom resource to be attached to the IP.
454454
:param region: Region to target. If none is passed will use default region from the config.
@@ -492,7 +492,7 @@ def detach_ip(
492492
region: Optional[ScwRegion] = None,
493493
) -> IP:
494494
"""
495-
Detach IP from a custom resource.
495+
Detach private IP from a custom resource.
496496
Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
497497
:param ip_id: IP ID.
498498
:param resource: Custom resource currently attached to the IP.
@@ -538,7 +538,7 @@ def move_ip(
538538
to_resource: Optional[CustomResource] = None,
539539
) -> IP:
540540
"""
541-
Move IP to a custom resource.
541+
Move private IP to a custom resource.
542542
Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
543543
:param ip_id: IP ID.
544544
:param from_resource: Custom resource currently attached to the IP.

0 commit comments

Comments
 (0)