Skip to content

Commit a7c186e

Browse files
authored
docs: improve rdb and redis documentation (#1596)
1 parent ec31c4c commit a7c186e

File tree

2 files changed

+128
-107
lines changed

2 files changed

+128
-107
lines changed

api/rdb/v1/rdb_sdk.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1407,7 +1407,7 @@ type ListNodeTypesRequest struct {
14071407
}
14081408

14091409
// ListNodeTypes: list available node types.
1410-
// 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.
1410+
// 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.
14111411
func (s *API) ListNodeTypes(req *ListNodeTypesRequest, opts ...scw.RequestOption) (*ListNodeTypesResponse, error) {
14121412
var err error
14131413

@@ -1467,7 +1467,7 @@ type ListDatabaseBackupsRequest struct {
14671467
}
14681468

14691469
// ListDatabaseBackups: list database backups.
1470-
// 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.
1470+
// 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.
14711471
func (s *API) ListDatabaseBackups(req *ListDatabaseBackupsRequest, opts ...scw.RequestOption) (*ListDatabaseBackupsResponse, error) {
14721472
var err error
14731473

@@ -1867,7 +1867,7 @@ type ListInstancesRequest struct {
18671867
}
18681868

18691869
// ListInstances: list Database Instances.
1870-
// 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.
1870+
// 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.
18711871
func (s *API) ListInstances(req *ListInstancesRequest, opts ...scw.RequestOption) (*ListInstancesResponse, error) {
18721872
var err error
18731873

@@ -2326,7 +2326,7 @@ type GetInstanceMetricsRequest struct {
23262326
}
23272327

23282328
// GetInstanceMetrics: get Database Instance metrics.
2329-
// 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`.
2329+
// 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`.
23302330
func (s *API) GetInstanceMetrics(req *GetInstanceMetricsRequest, opts ...scw.RequestOption) (*InstanceMetrics, error) {
23312331
var err error
23322332

@@ -3643,7 +3643,7 @@ type ListSnapshotsRequest struct {
36433643
}
36443644

36453645
// ListSnapshots: list snapshots.
3646-
// 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.
3646+
// 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.
36473647
func (s *API) ListSnapshots(req *ListSnapshotsRequest, opts ...scw.RequestOption) (*ListSnapshotsResponse, error) {
36483648
var err error
36493649

@@ -3929,7 +3929,7 @@ type CreateEndpointRequest struct {
39293929
}
39303930

39313931
// CreateEndpoint: create a new Database Instance endpoint.
3932-
// 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.
3932+
// 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.
39333933
func (s *API) CreateEndpoint(req *CreateEndpointRequest, opts ...scw.RequestOption) (*Endpoint, error) {
39343934
var err error
39353935

0 commit comments

Comments
 (0)