From 31143477a86701a6dc721408766ed34c820bf3cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Mon, 24 Apr 2023 14:58:57 +0200 Subject: [PATCH] fix --- .../test-all-usage-redis-cluster-create-usage.golden | 2 +- .../test-all-usage-redis-node-type-list-usage.golden | 2 +- .../test-all-usage-redis-setting-usage.golden | 2 +- .../test-all-usage-redis-version-list-usage.golden | 6 +++--- docs/commands/redis.md | 12 ++++++------ internal/namespaces/redis/v1/redis_cli.go | 12 ++++++------ 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden index b93e0c0fa1..87011243c2 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden @@ -18,7 +18,7 @@ ARGS: [acl-rules.{index}.description] Description of the rule [endpoints.{index}.private-network.id] UUID of the Private Network to connect to the Database Instance [endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. - [tls-enabled] Whether or not TLS is enabled + [tls-enabled] Defines whether or not TLS is enabled [cluster-settings.{index}.value] Value of the setting [cluster-settings.{index}.name] Name of the setting [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) diff --git a/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden b/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden index 6e0c105dc9..964eace77b 100644 --- a/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden @@ -6,7 +6,7 @@ USAGE: scw redis node-type list [arg=value ...] ARGS: - [include-disabled-types] Whether or not to include disabled types + [include-disabled-types] Defines whether or not to include disabled types [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-redis-setting-usage.golden b/cmd/scw/testdata/test-all-usage-redis-setting-usage.golden index 9c81cc7738..d4faf58230 100644 --- a/cmd/scw/testdata/test-all-usage-redis-setting-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-setting-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint. +Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](#path-redistm-engine-versions-list-available-redistm-versions) endpoint. Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform. diff --git a/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden b/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden index 5ee18150b3..eb26eef5b9 100644 --- a/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden @@ -6,9 +6,9 @@ USAGE: scw redis version list [arg=value ...] ARGS: - [include-disabled] Whether or not to include disabled Redis™ engine versions - [include-beta] Whether or not to include beta Redis™ engine versions - [include-deprecated] Whether or not to include deprecated Redis™ engine versions + [include-disabled] Defines whether or not to include disabled Redis™ engine versions + [include-beta] Defines whether or not to include beta Redis™ engine versions + [include-deprecated] Defines whether or not to include deprecated Redis™ engine versions [version] List Redis™ engine versions that match a given name pattern [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) diff --git a/docs/commands/redis.md b/docs/commands/redis.md index 7f2450652f..dd6c4700ec 100644 --- a/docs/commands/redis.md +++ b/docs/commands/redis.md @@ -156,7 +156,7 @@ scw redis cluster create [arg=value ...] | acl-rules.{index}.description | | Description of the rule | | endpoints.{index}.private-network.id | | UUID of the Private Network to connect to the Database Instance | | endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. | -| tls-enabled | | Whether or not TLS is enabled | +| tls-enabled | | Defines whether or not TLS is enabled | | cluster-settings.{index}.value | | Value of the setting | | cluster-settings.{index}.name | | Name of the setting | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | @@ -471,14 +471,14 @@ scw redis node-type list [arg=value ...] | Name | | Description | |------|---|-------------| -| include-disabled-types | | Whether or not to include disabled types | +| include-disabled-types | | Defines whether or not to include disabled types | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | ## Settings management commands -Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint. +Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](#path-redistm-engine-versions-list-available-redistm-versions) endpoint. Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform. @@ -569,9 +569,9 @@ scw redis version list [arg=value ...] | Name | | Description | |------|---|-------------| -| include-disabled | | Whether or not to include disabled Redis™ engine versions | -| include-beta | | Whether or not to include beta Redis™ engine versions | -| include-deprecated | | Whether or not to include deprecated Redis™ engine versions | +| include-disabled | | Defines whether or not to include disabled Redis™ engine versions | +| include-beta | | Defines whether or not to include beta Redis™ engine versions | +| include-deprecated | | Defines whether or not to include deprecated Redis™ engine versions | | version | | List Redis™ engine versions that match a given name pattern | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | diff --git a/internal/namespaces/redis/v1/redis_cli.go b/internal/namespaces/redis/v1/redis_cli.go index 14a51a8d18..e790db89b2 100644 --- a/internal/namespaces/redis/v1/redis_cli.go +++ b/internal/namespaces/redis/v1/redis_cli.go @@ -91,7 +91,7 @@ func redisVersion() *core.Command { func redisSetting() *core.Command { return &core.Command{ Short: `Settings management commands`, - Long: `Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint. + Long: `Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](#path-redistm-engine-versions-list-available-redistm-versions) endpoint. Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform. `, @@ -211,7 +211,7 @@ func redisClusterCreate() *core.Command { }, { Name: "tls-enabled", - Short: `Whether or not TLS is enabled`, + Short: `Defines whether or not TLS is enabled`, Required: false, Deprecated: false, Positional: false, @@ -550,7 +550,7 @@ func redisNodeTypeList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "include-disabled-types", - Short: `Whether or not to include disabled types`, + Short: `Defines whether or not to include disabled types`, Required: false, Deprecated: false, Positional: false, @@ -589,21 +589,21 @@ func redisVersionList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "include-disabled", - Short: `Whether or not to include disabled Redis™ engine versions`, + Short: `Defines whether or not to include disabled Redis™ engine versions`, Required: false, Deprecated: false, Positional: false, }, { Name: "include-beta", - Short: `Whether or not to include beta Redis™ engine versions`, + Short: `Defines whether or not to include beta Redis™ engine versions`, Required: false, Deprecated: false, Positional: false, }, { Name: "include-deprecated", - Short: `Whether or not to include deprecated Redis™ engine versions`, + Short: `Defines whether or not to include deprecated Redis™ engine versions`, Required: false, Deprecated: false, Positional: false,