Skip to content

docs(instance): fix terminate action documentation and remove b_ssd volumes documentation #1024

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
Jun 13, 2025
Merged

docs(instance): fix terminate action documentation and remove b_ssd volumes documentation #1024

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
8 changes: 4 additions & 4 deletions scaleway-async/scaleway_async/instance/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,11 +934,11 @@ async def server_action(
* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
* `reboot`: Stop the instance and restart it.
* `backup`: Create an image with all the volumes of an Instance.
* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
* `terminate`: Delete the Instance along with its attached local volumes.
* `enable_routed_ip`: Migrate the Instance to the new network stack.

The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
The `terminate` action will result in the deletion of `l_ssd` and `scratch` volumes types, `sbs_volume` volumes will only be detached.
If you want to preserve your `l_ssd` volumes, you should stop your Instance, detach the volumes to be preserved, then delete your Instance.

The `backup` action can be done with:
* No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types.
Expand Down Expand Up @@ -2208,7 +2208,7 @@ async def update_volume(
) -> UpdateVolumeResponse:
"""
Update a volume.
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size.
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s).
:param volume_id: UUID of the volume.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param name: Volume name.
Expand Down
8 changes: 4 additions & 4 deletions scaleway/scaleway/instance/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,11 +934,11 @@ def server_action(
* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
* `reboot`: Stop the instance and restart it.
* `backup`: Create an image with all the volumes of an Instance.
* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
* `terminate`: Delete the Instance along with its attached local volumes.
* `enable_routed_ip`: Migrate the Instance to the new network stack.

The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
The `terminate` action will result in the deletion of `l_ssd` and `scratch` volumes types, `sbs_volume` volumes will only be detached.
If you want to preserve your `l_ssd` volumes, you should stop your Instance, detach the volumes to be preserved, then delete your Instance.

The `backup` action can be done with:
* No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types.
Expand Down Expand Up @@ -2208,7 +2208,7 @@ def update_volume(
) -> UpdateVolumeResponse:
"""
Update a volume.
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size.
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s).
:param volume_id: UUID of the volume.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param name: Volume name.
Expand Down