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

scaleway-bot · web-flow · commit efd651ae0742 · 2025-03-06T16:40:30.000Z
diff --git a/api/vpcgw/v1/vpcgw_sdk.go b/api/vpcgw/v1/vpcgw_sdk.go
@@ -1467,6 +1467,7 @@ type MigrateToV2Request struct {
 	// Zone: zone to target. If none is passed will use default zone from the config.
 	Zone scw.Zone `json:"-"`
 
+	// GatewayID: ID of the gateway to put into IPAM mode.
 	GatewayID string `json:"-"`
 }
 
@@ -2946,7 +2947,7 @@ func (s *API) RefreshSSHKeys(req *RefreshSSHKeysRequest, opts ...scw.RequestOpti
 	return &resp, nil
 }
 
-// MigrateToV2:
+// MigrateToV2: Put a Public Gateway in IPAM mode, so that it can be used with the Public Gateways API v2. This call is idempotent.
 func (s *API) MigrateToV2(req *MigrateToV2Request, opts ...scw.RequestOption) error {
 	var err error
 

Original file line number	Diff line number	Diff line change
`@@ -1467,6 +1467,7 @@ type MigrateToV2Request struct {`
`1467`	`1467`	`// Zone: zone to target. If none is passed will use default zone from the config.`
`1468`	`1468`	Zone scw.Zone `json:"-"`
`1469`	`1469`
	`1470`	`+ // GatewayID: ID of the gateway to put into IPAM mode.`
`1470`	`1471`	GatewayID string `json:"-"`
`1471`	`1472`	`}`
`1472`	`1473`
`@@ -2946,7 +2947,7 @@ func (s API) RefreshSSHKeys(req RefreshSSHKeysRequest, opts ...scw.RequestOpti`
`2946`	`2947`	`return &resp, nil`
`2947`	`2948`	`}`
`2948`	`2949`
`2949`		`-// MigrateToV2:`
	`2950`	`+// MigrateToV2: Put a Public Gateway in IPAM mode, so that it can be used with the Public Gateways API v2. This call is idempotent.`
`2950`	`2951`	`func (s API) MigrateToV2(req MigrateToV2Request, opts ...scw.RequestOption) error {`
`2951`	`2952`	`var err error`
`2952`	`2953`