docs(ipam): document expected format of requested IP (#514)

scaleway-bot · web-flow · commit 114183dbc95f · 2024-05-03T14:47:30.000Z
diff --git a/scaleway-async/scaleway_async/ipam/v1/api.py b/scaleway-async/scaleway_async/ipam/v1/api.py
@@ -53,7 +53,7 @@ async def book_ip(
         :param is_ipv6: Request an IPv6 instead of an IPv4.
         :param region: Region to target. If none is passed will use default region from the config.
         :param project_id: When creating an IP in a Private Network, the Project must match the Private Network's Project.
-        :param address: Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
+        :param address: The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
         :param tags: Tags for the IP.
         :return: :class:`IP <IP>`
 
diff --git a/scaleway-async/scaleway_async/ipam/v1/marshalling.py b/scaleway-async/scaleway_async/ipam/v1/marshalling.py
@@ -28,7 +28,7 @@ def unmarshal_Resource(data: Any) -> Resource:
 
     args: Dict[str, Any] = {}
 
-    field = data.get("type_", None)
+    field = data.get("type", None)
     if field is not None:
         args["type_"] = field
 
@@ -39,10 +39,14 @@ def unmarshal_Resource(data: Any) -> Resource:
     field = data.get("mac_address", None)
     if field is not None:
         args["mac_address"] = field
+    else:
+        args["mac_address"] = None
 
     field = data.get("name", None)
     if field is not None:
         args["name"] = field
+    else:
+        args["name"] = None
 
     return Resource(**args)
 
@@ -62,6 +66,8 @@ def unmarshal_Reverse(data: Any) -> Reverse:
     field = data.get("address", None)
     if field is not None:
         args["address"] = field
+    else:
+        args["address"] = None
 
     return Reverse(**args)
 
@@ -77,14 +83,20 @@ def unmarshal_Source(data: Any) -> Source:
     field = data.get("zonal", None)
     if field is not None:
         args["zonal"] = field
+    else:
+        args["zonal"] = None
 
     field = data.get("private_network_id", None)
     if field is not None:
         args["private_network_id"] = field
+    else:
+        args["private_network_id"] = None
 
     field = data.get("subnet_id", None)
     if field is not None:
         args["subnet_id"] = field
+    else:
+        args["subnet_id"] = None
 
     return Source(**args)
 
@@ -134,18 +146,26 @@ def unmarshal_IP(data: Any) -> IP:
     field = data.get("created_at", None)
     if field is not None:
         args["created_at"] = parser.isoparse(field) if isinstance(field, str) else field
+    else:
+        args["created_at"] = None
 
     field = data.get("updated_at", None)
     if field is not None:
         args["updated_at"] = parser.isoparse(field) if isinstance(field, str) else field
+    else:
+        args["updated_at"] = None
 
     field = data.get("resource", None)
     if field is not None:
         args["resource"] = unmarshal_Resource(field)
+    else:
+        args["resource"] = None
 
     field = data.get("zone", None)
     if field is not None:
         args["zone"] = field
+    else:
+        args["zone"] = None
 
     return IP(**args)
 
diff --git a/scaleway-async/scaleway_async/ipam/v1/types.py b/scaleway-async/scaleway_async/ipam/v1/types.py
@@ -181,7 +181,7 @@ class BookIPRequest:
 
     address: Optional[str]
     """
-    Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
+    The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
     """
 
     tags: Optional[List[str]]
diff --git a/scaleway/scaleway/ipam/v1/api.py b/scaleway/scaleway/ipam/v1/api.py
@@ -53,7 +53,7 @@ def book_ip(
         :param is_ipv6: Request an IPv6 instead of an IPv4.
         :param region: Region to target. If none is passed will use default region from the config.
         :param project_id: When creating an IP in a Private Network, the Project must match the Private Network's Project.
-        :param address: Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
+        :param address: The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
         :param tags: Tags for the IP.
         :return: :class:`IP <IP>`
 
diff --git a/scaleway/scaleway/ipam/v1/marshalling.py b/scaleway/scaleway/ipam/v1/marshalling.py
@@ -28,7 +28,7 @@ def unmarshal_Resource(data: Any) -> Resource:
 
     args: Dict[str, Any] = {}
 
-    field = data.get("type_", None)
+    field = data.get("type", None)
     if field is not None:
         args["type_"] = field
 
@@ -39,10 +39,14 @@ def unmarshal_Resource(data: Any) -> Resource:
     field = data.get("mac_address", None)
     if field is not None:
         args["mac_address"] = field
+    else:
+        args["mac_address"] = None
 
     field = data.get("name", None)
     if field is not None:
         args["name"] = field
+    else:
+        args["name"] = None
 
     return Resource(**args)
 
@@ -62,6 +66,8 @@ def unmarshal_Reverse(data: Any) -> Reverse:
     field = data.get("address", None)
     if field is not None:
         args["address"] = field
+    else:
+        args["address"] = None
 
     return Reverse(**args)
 
@@ -77,14 +83,20 @@ def unmarshal_Source(data: Any) -> Source:
     field = data.get("zonal", None)
     if field is not None:
         args["zonal"] = field
+    else:
+        args["zonal"] = None
 
     field = data.get("private_network_id", None)
     if field is not None:
         args["private_network_id"] = field
+    else:
+        args["private_network_id"] = None
 
     field = data.get("subnet_id", None)
     if field is not None:
         args["subnet_id"] = field
+    else:
+        args["subnet_id"] = None
 
     return Source(**args)
 
@@ -134,18 +146,26 @@ def unmarshal_IP(data: Any) -> IP:
     field = data.get("created_at", None)
     if field is not None:
         args["created_at"] = parser.isoparse(field) if isinstance(field, str) else field
+    else:
+        args["created_at"] = None
 
     field = data.get("updated_at", None)
     if field is not None:
         args["updated_at"] = parser.isoparse(field) if isinstance(field, str) else field
+    else:
+        args["updated_at"] = None
 
     field = data.get("resource", None)
     if field is not None:
         args["resource"] = unmarshal_Resource(field)
+    else:
+        args["resource"] = None
 
     field = data.get("zone", None)
     if field is not None:
         args["zone"] = field
+    else:
+        args["zone"] = None
 
     return IP(**args)
 
diff --git a/scaleway/scaleway/ipam/v1/types.py b/scaleway/scaleway/ipam/v1/types.py
@@ -181,7 +181,7 @@ class BookIPRequest:
 
     address: Optional[str]
     """
-    Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
+    The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already booked, then the call will fail.
     """
 
     tags: Optional[List[str]]
