Skip to content

docs(vpc_gw): document MigrateToV2 #894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2025
Merged

docs(vpc_gw): document MigrateToV2 #894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion scaleway-async/scaleway_async/vpcgw/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions scaleway-async/scaleway_async/vpcgw/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1443,6 +1443,9 @@ class ListPATRulesResponse:
@dataclass
class MigrateToV2Request:
gateway_id: str
"""
ID of the gateway to put into IPAM mode.
"""

zone: Optional[ScwZone]
"""
Expand Down
4 changes: 3 additions & 1 deletion scaleway/scaleway/vpcgw/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions scaleway/scaleway/vpcgw/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1443,6 +1443,9 @@ class ListPATRulesResponse:
@dataclass
class MigrateToV2Request:
gateway_id: str
"""
ID of the gateway to put into IPAM mode.
"""

zone: Optional[ScwZone]
"""
Expand Down