docs(vpc_gw): document MigrateToV2 (scaleway#894)

scaleway-bot · web-flow · commit c571b7aaeda4 · 2025-03-06T16:39:46.000Z
diff --git a/scaleway-async/scaleway_async/vpcgw/v1/api.py b/scaleway-async/scaleway_async/vpcgw/v1/api.py
@@ -2088,7 +2088,9 @@ async def migrate_to_v2(
         zone: Optional[ScwZone] = None,
     ) -> None:
         """
-        :param gateway_id:
+        Put a Public Gateway in IPAM mode.
+        Put a Public Gateway in IPAM mode, so that it can be used with the Public Gateways API v2. This call is idempotent.
+        :param gateway_id: ID of the gateway to put into IPAM mode.
         :param zone: Zone to target. If none is passed will use default zone from the config.
 
         Usage:
diff --git a/scaleway-async/scaleway_async/vpcgw/v1/types.py b/scaleway-async/scaleway_async/vpcgw/v1/types.py
@@ -1443,6 +1443,9 @@ class ListPATRulesResponse:
 @dataclass
 class MigrateToV2Request:
     gateway_id: str
+    """
+    ID of the gateway to put into IPAM mode.
+    """
 
     zone: Optional[ScwZone]
     """
diff --git a/scaleway/scaleway/vpcgw/v1/api.py b/scaleway/scaleway/vpcgw/v1/api.py
@@ -2086,7 +2086,9 @@ def migrate_to_v2(
         zone: Optional[ScwZone] = None,
     ) -> None:
         """
-        :param gateway_id:
+        Put a Public Gateway in IPAM mode.
+        Put a Public Gateway in IPAM mode, so that it can be used with the Public Gateways API v2. This call is idempotent.
+        :param gateway_id: ID of the gateway to put into IPAM mode.
         :param zone: Zone to target. If none is passed will use default zone from the config.
 
         Usage:
diff --git a/scaleway/scaleway/vpcgw/v1/types.py b/scaleway/scaleway/vpcgw/v1/types.py
@@ -1443,6 +1443,9 @@ class ListPATRulesResponse:
 @dataclass
 class MigrateToV2Request:
     gateway_id: str
+    """
+    ID of the gateway to put into IPAM mode.
+    """
 
     zone: Optional[ScwZone]
     """
