docs(instance): mark some fields as deprecated following ipmob introduction (#494)

Author: scaleway-bot

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

@@ -366,6 +366,7 @@ async def list_servers(
         name: Optional[str] = None,
         private_ip: Optional[str] = None,
         without_ip: Optional[bool] = None,
+        with_ip: Optional[str] = None,
         commercial_type: Optional[str] = None,
         state: Optional[ServerState] = None,
         tags: Optional[List[str]] = None,
@@ -386,6 +387,7 @@ async def list_servers(
         :param name: Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo").
         :param private_ip: List Instances by private_ip.
         :param without_ip: List Instances that are not attached to a public IP.
+        :param with_ip: List Instances by IP (both private_ip and public_ip are supported).
         :param commercial_type: List Instances of this commercial type.
         :param state: List Instances in this state.
         :param tags: List Instances with these exact tags (to filter with several tags, use commas to separate them).
@@ -424,6 +426,7 @@ async def list_servers(
                 "servers": ",".join(servers) if servers and len(servers) > 0 else None,
                 "state": state,
                 "tags": ",".join(tags) if tags and len(tags) > 0 else None,
+                "with_ip": with_ip,
                 "without_ip": without_ip,
             },
         )
@@ -442,6 +445,7 @@ async def list_servers_all(
         name: Optional[str] = None,
         private_ip: Optional[str] = None,
         without_ip: Optional[bool] = None,
+        with_ip: Optional[str] = None,
         commercial_type: Optional[str] = None,
         state: Optional[ServerState] = None,
         tags: Optional[List[str]] = None,
@@ -462,6 +466,7 @@ async def list_servers_all(
         :param name: Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo").
         :param private_ip: List Instances by private_ip.
         :param without_ip: List Instances that are not attached to a public IP.
+        :param with_ip: List Instances by IP (both private_ip and public_ip are supported).
         :param commercial_type: List Instances of this commercial type.
         :param state: List Instances in this state.
         :param tags: List Instances with these exact tags (to filter with several tags, use commas to separate them).
@@ -491,6 +496,7 @@ async def list_servers_all(
                 "name": name,
                 "private_ip": private_ip,
                 "without_ip": without_ip,
+                "with_ip": with_ip,
                 "commercial_type": commercial_type,
                 "state": state,
                 "tags": tags,
@@ -507,12 +513,12 @@ async def _create_server(
         *,
         commercial_type: str,
         image: str,
-        enable_ipv6: bool,
         zone: Optional[Zone] = None,
         name: Optional[str] = None,
         dynamic_ip_required: Optional[bool] = None,
         routed_ip_enabled: Optional[bool] = None,
         volumes: Optional[Dict[str, VolumeServerTemplate]] = None,
+        enable_ipv6: Optional[bool] = None,
         public_ip: Optional[str] = None,
         public_ips: Optional[List[str]] = None,
         boot_type: Optional[BootType] = None,
@@ -529,12 +535,12 @@ async def _create_server(
         Get more information in the [Technical Information](#technical-information) section of the introduction.
         :param commercial_type: Define the Instance commercial type (i.e. GP1-S).
         :param image: Instance image ID or label.
-        :param enable_ipv6: True if IPv6 is enabled on the server.
         :param zone: Zone to target. If none is passed will use default zone from the config.
         :param name: Instance name.
         :param dynamic_ip_required: Define if a dynamic IPv4 is required for the Instance.
         :param routed_ip_enabled: If true, configure the Instance so it uses the new routed IP mode.
         :param volumes: Volumes attached to the server.
+        :param enable_ipv6: True if IPv6 is enabled on the server (deprecated and always `False` when `routed_ip_enabled` is `True`).
         :param public_ip: ID of the reserved IP to attach to the Instance.
         :param public_ips: A list of reserved IP IDs to attach to the Instance.
         :param boot_type: Boot type to use.
@@ -554,7 +560,6 @@ async def _create_server(
             result = await api._create_server(
                 commercial_type="example",
                 image="example",
-                enable_ipv6=False,
             )
         """
 
@@ -565,14 +570,14 @@ async def _create_server(
             f"/instance/v1/zones/{param_zone}/servers",
             body=marshal_CreateServerRequest(
                 CreateServerRequest(
-                    zone=zone,
                     commercial_type=commercial_type,
                     image=image,
+                    zone=zone,
                     name=name or random_name(prefix="srv"),
                     dynamic_ip_required=dynamic_ip_required,
                     routed_ip_enabled=routed_ip_enabled,
-                    enable_ipv6=enable_ipv6,
                     volumes=volumes,
+                    enable_ipv6=enable_ipv6,
                     public_ip=public_ip,
                     public_ips=public_ips,
                     boot_type=boot_type,
@@ -660,14 +665,14 @@ async def _set_server(
         name: str,
         commercial_type: str,
         dynamic_ip_required: bool,
-        enable_ipv6: bool,
         hostname: str,
         organization: Optional[str] = None,
         project: Optional[str] = None,
         allowed_actions: Optional[List[ServerAction]] = None,
         tags: Optional[List[str]] = None,
         creation_date: Optional[datetime] = None,
         routed_ip_enabled: Optional[bool] = None,
+        enable_ipv6: Optional[bool] = None,
         image: Optional[Image] = None,
         protected: bool,
         private_ip: Optional[str] = None,
@@ -693,24 +698,24 @@ async def _set_server(
         :param name: Instance name.
         :param commercial_type: Instance commercial type (eg. GP1-M).
         :param dynamic_ip_required: True if a dynamic IPv4 is required.
-        :param enable_ipv6: True if IPv6 is enabled.
         :param hostname: Instance host name.
         :param organization: Instance Organization ID.
         :param project: Instance Project ID.
         :param allowed_actions: Provide a list of allowed actions on the server.
         :param tags: Tags associated with the Instance.
         :param creation_date: Instance creation date.
         :param routed_ip_enabled: True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False).
+        :param enable_ipv6: True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`).
         :param image: Provide information on the Instance image.
         :param protected: Instance protection option is activated.
-        :param private_ip: Instance private IP address.
-        :param public_ip: Information about the public IP.
+        :param private_ip: Instance private IP address (deprecated and always `null` when `routed_ip_enabled` is `True`).
+        :param public_ip: Information about the public IP (deprecated in favor of `public_ips`).
         :param public_ips: Information about all the public IPs attached to the server.
         :param modification_date: Instance modification date.
         :param state_detail: Instance state_detail.
         :param state: Instance state.
         :param location: Instance location.
-        :param ipv6: Instance IPv6 address.
+        :param ipv6: Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`).
         :param bootscript: Instance bootscript.
         :param boot_type: Instance boot type.
         :param volumes: Instance volumes.
@@ -729,7 +734,6 @@ async def _set_server(
                 name="example",
                 commercial_type="example",
                 dynamic_ip_required=False,
-                enable_ipv6=False,
                 hostname="example",
                 protected=False,
                 state_detail="example",
@@ -749,14 +753,14 @@ async def _set_server(
                     name=name,
                     commercial_type=commercial_type,
                     dynamic_ip_required=dynamic_ip_required,
-                    enable_ipv6=enable_ipv6,
                     hostname=hostname,
                     organization=organization,
                     project=project,
                     allowed_actions=allowed_actions,
                     tags=tags,
                     creation_date=creation_date,
                     routed_ip_enabled=routed_ip_enabled,
+                    enable_ipv6=enable_ipv6,
                     image=image,
                     protected=protected,
                     private_ip=private_ip,

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

@@ -741,10 +741,6 @@ def unmarshal_Server(data: Any) -> Server:
     if field is not None:
         args["routed_ip_enabled"] = field
 
-    field = data.get("enable_ipv6", None)
-    if field is not None:
-        args["enable_ipv6"] = field
-
     field = data.get("hostname", None)
     if field is not None:
         args["hostname"] = field
@@ -753,6 +749,10 @@ def unmarshal_Server(data: Any) -> Server:
     if field is not None:
         args["protected"] = field
 
+    field = data.get("enable_ipv6", None)
+    if field is not None:
+        args["enable_ipv6"] = field
+
     field = data.get("image", None)
     if field is not None:
         args["image"] = unmarshal_Image(field)
@@ -2877,15 +2877,15 @@ def marshal_CreateServerRequest(
     if request.routed_ip_enabled is not None:
         output["routed_ip_enabled"] = request.routed_ip_enabled
 
-    if request.enable_ipv6 is not None:
-        output["enable_ipv6"] = request.enable_ipv6
-
     if request.volumes is not None:
         output["volumes"] = {
             key: marshal_VolumeServerTemplate(value, defaults)
             for key, value in request.volumes.items()
         }
 
+    if request.enable_ipv6 is not None:
+        output["enable_ipv6"] = request.enable_ipv6
+
     if request.public_ip is not None:
         output["public_ip"] = request.public_ip
 
@@ -3972,9 +3972,6 @@ def marshal__SetServerRequest(
     if request.dynamic_ip_required is not None:
         output["dynamic_ip_required"] = request.dynamic_ip_required
 
-    if request.enable_ipv6 is not None:
-        output["enable_ipv6"] = request.enable_ipv6
-
     if request.hostname is not None:
         output["hostname"] = request.hostname
 
@@ -3998,6 +3995,9 @@ def marshal__SetServerRequest(
     if request.routed_ip_enabled is not None:
         output["routed_ip_enabled"] = request.routed_ip_enabled
 
+    if request.enable_ipv6 is not None:
+        output["enable_ipv6"] = request.enable_ipv6
+
     if request.image is not None:
         output["image"] = (marshal_Image(request.image, defaults),)
 

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

@@ -842,11 +842,6 @@ class Server:
     True to configure the instance so it uses the new routed IP mode.
     """
 
-    enable_ipv6: bool
-    """
-    True if IPv6 is enabled.
-    """
-
     hostname: str
     """
     Instance host name.
@@ -857,19 +852,24 @@ class Server:
     Defines whether the Instance protection option is activated.
     """
 
+    enable_ipv6: Optional[bool]
+    """
+    True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`).
+    """
+
     image: Optional[Image]
     """
     Information about the Instance image.
     """
 
     private_ip: Optional[str]
     """
-    Private IP address of the Instance.
+    Private IP address of the Instance (deprecated and always `null` when `routed_ip_enabled` is `True`).
     """
 
     public_ip: Optional[ServerIp]
     """
-    Information about the public IP.
+    Information about the public IP (deprecated in favor of `public_ips`).
     """
 
     public_ips: List[ServerIp]
@@ -909,7 +909,7 @@ class Server:
 
     ipv6: Optional[ServerIpv6]
     """
-    Instance IPv6 address.
+    Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`).
     """
 
     bootscript: Optional[Bootscript]
@@ -1783,11 +1783,6 @@ class CreateSecurityGroupRuleResponse:
 
 @dataclass
 class CreateServerRequest:
-    zone: Optional[Zone]
-    """
-    Zone to target. If none is passed will use default zone from the config.
-    """
-
     commercial_type: str
     """
     Define the Instance commercial type (i.e. GP1-S).
@@ -1798,6 +1793,11 @@ class CreateServerRequest:
     Instance image ID or label.
     """
 
+    zone: Optional[Zone]
+    """
+    Zone to target. If none is passed will use default zone from the config.
+    """
+
     name: Optional[str]
     """
     Instance name.
@@ -1813,14 +1813,14 @@ class CreateServerRequest:
     If true, configure the Instance so it uses the new routed IP mode.
     """
 
-    enable_ipv6: bool
+    volumes: Optional[Dict[str, VolumeServerTemplate]]
     """
-    True if IPv6 is enabled on the server.
+    Volumes attached to the server.
     """
 
-    volumes: Optional[Dict[str, VolumeServerTemplate]]
+    enable_ipv6: Optional[bool]
     """
-    Volumes attached to the server.
+    True if IPv6 is enabled on the server (deprecated and always `False` when `routed_ip_enabled` is `True`).
     """
 
     public_ip: Optional[str]
@@ -2774,6 +2774,11 @@ class ListServersRequest:
     List Instances that are not attached to a public IP.
     """
 
+    with_ip: Optional[str]
+    """
+    List Instances by IP (both private_ip and public_ip are supported).
+    """
+
     commercial_type: Optional[str]
     """
     List Instances of this commercial type.

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

@@ -164,10 +164,6 @@ class _SetServerRequest:
     """
     True if a dynamic IPv4 is required.
     """
-    enable_ipv6: bool
-    """
-    True if IPv6 is enabled.
-    """
     hostname: str
     """
     Instance host name.
@@ -196,6 +192,10 @@ class _SetServerRequest:
     """
     True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False).
     """
+    enable_ipv6: Optional[bool]
+    """
+    True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`).
+    """
     image: Optional[Image]
     """
     Provide information on the Instance image.
@@ -206,11 +206,11 @@ class _SetServerRequest:
     """
     private_ip: Optional[str]
     """
-    Instance private IP address.
+    Instance private IP address (deprecated and always `null` when `routed_ip_enabled` is `True`).
     """
     public_ip: Optional[ServerIp]
     """
-    Information about the public IP.
+    Information about the public IP (deprecated in favor of `public_ips`).
     """
     public_ips: Optional[List[ServerIp]]
     """
@@ -234,7 +234,7 @@ class _SetServerRequest:
     """
     ipv6: Optional[ServerIpv6]
     """
-    Instance IPv6 address.
+    Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`).
     """
     bootscript: Optional[Bootscript]
     """