Skip to content

Commit a62d149

Browse files
docs(instance): change documentation for dynamic_ip_required (#1081)
Co-authored-by: Rémy Léone <rleone@scaleway.com>
1 parent e55fa6f commit a62d149

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ async def _create_server(
545545
:param zone: Zone to target. If none is passed will use default zone from the config.
546546
:param commercial_type: Define the Instance commercial type (i.e. GP1-S).
547547
:param name: Instance name.
548-
:param dynamic_ip_required: Define if a dynamic IPv4 is required for the Instance.
548+
:param dynamic_ip_required: By default, `dynamic_ip_required` is true, a dynamic ip is attached to the instance (if no flexible ip is already attached).
549549
:param routed_ip_enabled: If true, configure the Instance so it uses the new routed IP mode.
550550
:param image: Instance image ID or label.
551551
:param volumes: Volumes attached to the server.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1859,7 +1859,7 @@ class CreateServerRequest:
18591859

18601860
dynamic_ip_required: Optional[bool]
18611861
"""
1862-
Define if a dynamic IPv4 is required for the Instance.
1862+
By default, `dynamic_ip_required` is true, a dynamic ip is attached to the instance (if no flexible ip is already attached).
18631863
"""
18641864

18651865
routed_ip_enabled: Optional[bool]

scaleway/scaleway/instance/v1/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ def _create_server(
545545
:param zone: Zone to target. If none is passed will use default zone from the config.
546546
:param commercial_type: Define the Instance commercial type (i.e. GP1-S).
547547
:param name: Instance name.
548-
:param dynamic_ip_required: Define if a dynamic IPv4 is required for the Instance.
548+
:param dynamic_ip_required: By default, `dynamic_ip_required` is true, a dynamic ip is attached to the instance (if no flexible ip is already attached).
549549
:param routed_ip_enabled: If true, configure the Instance so it uses the new routed IP mode.
550550
:param image: Instance image ID or label.
551551
:param volumes: Volumes attached to the server.

scaleway/scaleway/instance/v1/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1859,7 +1859,7 @@ class CreateServerRequest:
18591859

18601860
dynamic_ip_required: Optional[bool]
18611861
"""
1862-
Define if a dynamic IPv4 is required for the Instance.
1862+
By default, `dynamic_ip_required` is true, a dynamic ip is attached to the instance (if no flexible ip is already attached).
18631863
"""
18641864

18651865
routed_ip_enabled: Optional[bool]

0 commit comments

Comments
 (0)