Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ async def get_os(
) -> OS:
"""
Get an Operating System (OS).
Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
:param os_id: UUID of the OS you want to get.
:param zone: Zone to target. If none is passed will use default zone from the config.
:return: :class:`OS <OS>`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ async def delete_instance_group(
zone: Optional[ScwZone] = None,
) -> None:
"""
Delete Instance group.
Delete Instance group.
Delete an existing Instance group, specified by its `instance_group_id`. Deleting an Instance group is permanent, and cannot be undone.
:param instance_group_id: ID of the Instance group to delete.
:param zone: Zone to target. If none is passed will use default zone from the config.
Expand Down
4 changes: 2 additions & 2 deletions scaleway-async/scaleway_async/dedibox/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -984,7 +984,7 @@ class ServiceLevel:
class RpnSan:
id: int
"""
RPN SAN ID.
RPN SAN ID.
"""

datacenter_name: str
Expand Down Expand Up @@ -1711,7 +1711,7 @@ class RpnGroupMember:
class RpnSanSummary:
id: int
"""
RPN SAN ID.
RPN SAN ID.
"""

datacenter_name: str
Expand Down
2 changes: 1 addition & 1 deletion scaleway-async/scaleway_async/iam/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,7 @@ class Log:

resource_id: str
"""
ID of the resource linked to the log.
ID of the resource linked to the log.
"""

created_at: Optional[datetime] = None
Expand Down
2 changes: 1 addition & 1 deletion scaleway-async/scaleway_async/instance/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,7 @@ async def server_action(
* `poweroff`: Fully stop the Instance and release the hypervisor slot.
* `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.
* `backup`: Create an image with all the volumes of an Instance.
* `terminate`: Delete the Instance along with its attached local volumes.
* `enable_routed_ip`: Migrate the Instance to the new network stack.

Expand Down
4 changes: 2 additions & 2 deletions scaleway-async/scaleway_async/iot/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1498,7 +1498,7 @@ async def create_network(
) -> CreateNetworkResponse:
"""
Create a new network.
Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
:param type_: Type of network to connect with.
:param hub_id: Hub ID to connect the Network to.
:param topic_prefix: Topic prefix for the Network.
Expand Down Expand Up @@ -1546,7 +1546,7 @@ async def get_network(
) -> Network:
"""
Retrieve a specific network.
Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
:param network_id: Network ID.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`Network <Network>`
Expand Down
4 changes: 2 additions & 2 deletions scaleway-async/scaleway_async/lb/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1724,7 +1724,7 @@ async def list_routes(
) -> ListRoutesResponse:
"""
List all routes.
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param order_by: Sort order of routes in the response.
:param page_size: The number of route objects to return.
Expand Down Expand Up @@ -1765,7 +1765,7 @@ async def list_routes_all(
) -> list[Route]:
"""
List all routes.
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param order_by: Sort order of routes in the response.
:param page_size: The number of route objects to return.
Expand Down
8 changes: 4 additions & 4 deletions scaleway-async/scaleway_async/rdb/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1416,7 +1416,7 @@ async def get_read_replica(
) -> ReadReplica:
"""
Get a Read Replica.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
:param read_replica_id: UUID of the Read Replica.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`ReadReplica <ReadReplica>`
Expand Down Expand Up @@ -1453,7 +1453,7 @@ async def wait_for_read_replica(
) -> ReadReplica:
"""
Get a Read Replica.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
:param read_replica_id: UUID of the Read Replica.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`ReadReplica <ReadReplica>`
Expand Down Expand Up @@ -2420,7 +2420,7 @@ async def delete_user(
) -> None:
"""
Delete a user on a Database Instance.
Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete.
Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete.
:param instance_id: UUID of the Database Instance to delete the user from.
:param name: Name of the user.
:param region: Region to target. If none is passed will use default region from the config.
Expand Down Expand Up @@ -3061,7 +3061,7 @@ async def delete_snapshot(
) -> Snapshot:
"""
Delete a Database Instance snapshot.
Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete.
Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete.
:param snapshot_id: UUID of the snapshot to delete.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`Snapshot <Snapshot>`
Expand Down
2 changes: 1 addition & 1 deletion scaleway-async/scaleway_async/registry/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ async def update_image(
Update the parameters of a given image, specified by its `image_id` and `region`. You can update the `visibility` parameter.
:param image_id: ID of the image to update.
:param region: Region to target. If none is passed will use default region from the config.
:param visibility: Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
:param visibility: Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
:return: :class:`Image <Image>`

Usage:
Expand Down
4 changes: 2 additions & 2 deletions scaleway-async/scaleway_async/registry/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class Image:

visibility: ImageVisibility
"""
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
"""

size: int
Expand Down Expand Up @@ -535,7 +535,7 @@ class UpdateImageRequest:

visibility: Optional[ImageVisibility] = ImageVisibility.VISIBILITY_UNKNOWN
"""
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
"""


Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/applesilicon/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ def get_os(
) -> OS:
"""
Get an Operating System (OS).
Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
:param os_id: UUID of the OS you want to get.
:param zone: Zone to target. If none is passed will use default zone from the config.
:return: :class:`OS <OS>`
Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/autoscaling/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ def delete_instance_group(
zone: Optional[ScwZone] = None,
) -> None:
"""
Delete Instance group.
Delete Instance group.
Delete an existing Instance group, specified by its `instance_group_id`. Deleting an Instance group is permanent, and cannot be undone.
:param instance_group_id: ID of the Instance group to delete.
:param zone: Zone to target. If none is passed will use default zone from the config.
Expand Down
4 changes: 2 additions & 2 deletions scaleway/scaleway/dedibox/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -984,7 +984,7 @@ class ServiceLevel:
class RpnSan:
id: int
"""
RPN SAN ID.
RPN SAN ID.
"""

datacenter_name: str
Expand Down Expand Up @@ -1711,7 +1711,7 @@ class RpnGroupMember:
class RpnSanSummary:
id: int
"""
RPN SAN ID.
RPN SAN ID.
"""

datacenter_name: str
Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/iam/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,7 @@ class Log:

resource_id: str
"""
ID of the resource linked to the log.
ID of the resource linked to the log.
"""

created_at: Optional[datetime] = None
Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/instance/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,7 @@ def server_action(
* `poweroff`: Fully stop the Instance and release the hypervisor slot.
* `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.
* `backup`: Create an image with all the volumes of an Instance.
* `terminate`: Delete the Instance along with its attached local volumes.
* `enable_routed_ip`: Migrate the Instance to the new network stack.

Expand Down
4 changes: 2 additions & 2 deletions scaleway/scaleway/iot/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1498,7 +1498,7 @@ def create_network(
) -> CreateNetworkResponse:
"""
Create a new network.
Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
:param type_: Type of network to connect with.
:param hub_id: Hub ID to connect the Network to.
:param topic_prefix: Topic prefix for the Network.
Expand Down Expand Up @@ -1546,7 +1546,7 @@ def get_network(
) -> Network:
"""
Retrieve a specific network.
Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
:param network_id: Network ID.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`Network <Network>`
Expand Down
4 changes: 2 additions & 2 deletions scaleway/scaleway/lb/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1724,7 +1724,7 @@ def list_routes(
) -> ListRoutesResponse:
"""
List all routes.
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param order_by: Sort order of routes in the response.
:param page_size: The number of route objects to return.
Expand Down Expand Up @@ -1765,7 +1765,7 @@ def list_routes_all(
) -> list[Route]:
"""
List all routes.
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param order_by: Sort order of routes in the response.
:param page_size: The number of route objects to return.
Expand Down
8 changes: 4 additions & 4 deletions scaleway/scaleway/rdb/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1412,7 +1412,7 @@ def get_read_replica(
) -> ReadReplica:
"""
Get a Read Replica.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
:param read_replica_id: UUID of the Read Replica.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`ReadReplica <ReadReplica>`
Expand Down Expand Up @@ -1447,7 +1447,7 @@ def wait_for_read_replica(
) -> ReadReplica:
"""
Get a Read Replica.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
:param read_replica_id: UUID of the Read Replica.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`ReadReplica <ReadReplica>`
Expand Down Expand Up @@ -2412,7 +2412,7 @@ def delete_user(
) -> None:
"""
Delete a user on a Database Instance.
Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete.
Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete.
:param instance_id: UUID of the Database Instance to delete the user from.
:param name: Name of the user.
:param region: Region to target. If none is passed will use default region from the config.
Expand Down Expand Up @@ -3051,7 +3051,7 @@ def delete_snapshot(
) -> Snapshot:
"""
Delete a Database Instance snapshot.
Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete.
Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete.
:param snapshot_id: UUID of the snapshot to delete.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`Snapshot <Snapshot>`
Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/registry/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@ def update_image(
Update the parameters of a given image, specified by its `image_id` and `region`. You can update the `visibility` parameter.
:param image_id: ID of the image to update.
:param region: Region to target. If none is passed will use default region from the config.
:param visibility: Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
:param visibility: Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
:return: :class:`Image <Image>`

Usage:
Expand Down
4 changes: 2 additions & 2 deletions scaleway/scaleway/registry/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class Image:

visibility: ImageVisibility
"""
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
"""

size: int
Expand Down Expand Up @@ -535,7 +535,7 @@ class UpdateImageRequest:

visibility: Optional[ImageVisibility] = ImageVisibility.VISIBILITY_UNKNOWN
"""
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
"""


Expand Down
Loading