Skip to content

Commit 070e896

Browse files
authored
docs: improve rdb and redis documentation (#102)
1 parent 9e04346 commit 070e896

File tree

6 files changed

+364
-316
lines changed

6 files changed

+364
-316
lines changed

scaleway-async/scaleway_async/rdb/v1/api.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ async def list_node_types(
253253
) -> ListNodeTypesResponse:
254254
"""
255255
List available node types.
256-
List all available node types. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
256+
List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
257257
:param region: Region to target. If none is passed will use default region from the config.
258258
:param include_disabled_types: Defines whether or not to include disabled types.
259259
:param page:
@@ -293,7 +293,7 @@ async def list_node_types_all(
293293
) -> List[NodeType]:
294294
"""
295295
List available node types.
296-
List all available node types. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
296+
List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
297297
:param region: Region to target. If none is passed will use default region from the config.
298298
:param include_disabled_types: Defines whether or not to include disabled types.
299299
:param page:
@@ -332,7 +332,7 @@ async def list_database_backups(
332332
) -> ListDatabaseBackupsResponse:
333333
"""
334334
List database backups.
335-
List all backups in a specified zone, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
335+
List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
336336
:param region: Region to target. If none is passed will use default region from the config.
337337
:param name: Name of the database backups.
338338
:param order_by: Criteria to use when ordering database backups listing.
@@ -385,7 +385,7 @@ async def list_database_backups_all(
385385
) -> List[DatabaseBackup]:
386386
"""
387387
List database backups.
388-
List all backups in a specified zone, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
388+
List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
389389
:param region: Region to target. If none is passed will use default region from the config.
390390
:param name: Name of the database backups.
391391
:param order_by: Criteria to use when ordering database backups listing.
@@ -785,7 +785,7 @@ async def list_instances(
785785
) -> ListInstancesResponse:
786786
"""
787787
List Database Instances.
788-
List all Database Instances in the specified zone, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
788+
List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
789789
:param region: Region to target. If none is passed will use default region from the config.
790790
:param tags: List Database Instances that have a given tag.
791791
:param name: Lists Database Instances that match a name pattern.
@@ -838,7 +838,7 @@ async def list_instances_all(
838838
) -> List[Instance]:
839839
"""
840840
List Database Instances.
841-
List all Database Instances in the specified zone, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
841+
List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
842842
:param region: Region to target. If none is passed will use default region from the config.
843843
:param tags: List Database Instances that have a given tag.
844844
:param name: Lists Database Instances that match a name pattern.
@@ -1281,7 +1281,7 @@ async def get_instance_metrics(
12811281
) -> InstanceMetrics:
12821282
"""
12831283
Get Database Instance metrics.
1284-
Retrieve the time series metrics of a give Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
1284+
Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
12851285
:param region: Region to target. If none is passed will use default region from the config.
12861286
:param instance_id: UUID of the Database Instance.
12871287
:param start_date: Start date to gather metrics from.
@@ -2675,7 +2675,7 @@ async def list_snapshots(
26752675
) -> ListSnapshotsResponse:
26762676
"""
26772677
List snapshots.
2678-
List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snaphots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
2678+
List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
26792679
:param region: Region to target. If none is passed will use default region from the config.
26802680
:param name: Name of the snapshot.
26812681
:param order_by: Criteria to use when ordering snapshot listing.
@@ -2728,7 +2728,7 @@ async def list_snapshots_all(
27282728
) -> List[Snapshot]:
27292729
"""
27302730
List snapshots.
2731-
List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snaphots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
2731+
List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
27322732
:param region: Region to target. If none is passed will use default region from the config.
27332733
:param name: Name of the snapshot.
27342734
:param order_by: Criteria to use when ordering snapshot listing.
@@ -3012,7 +3012,7 @@ async def create_endpoint(
30123012
) -> Endpoint:
30133013
"""
30143014
Create a new Database Instance endpoint.
3015-
Create a new endpoint for a Database Instance. You can add `load_balacer` and `private_network` specifications to the body of the request. Note that this action replaces your current endpoint, which means you might need to update any environment configurations that point to the old endpoint.
3015+
Create a new endpoint for a Database Instance. You can add `load_balancer` and `private_network` specifications to the body of the request. Note that this action replaces your current endpoint, which means you might need to update any environment configurations that point to the old endpoint.
30163016
:param region: Region to target. If none is passed will use default region from the config.
30173017
:param instance_id: UUID of the Database Instance you to which you want to add an endpoint.
30183018
:param endpoint_spec: Specification of the endpoint you want to create.

0 commit comments

Comments
 (0)