Skip to content

Commit

Permalink
chore(redis): fix naming convention (#2423)
Browse files Browse the repository at this point in the history
Co-authored-by: Rémy Léone <rleone@scaleway.com>
  • Loading branch information
scaleway-bot and remyleone authored Jul 29, 2022
1 parent 4213bb7 commit 4b31b4a
Show file tree
Hide file tree
Showing 10 changed files with 42 additions and 42 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ USAGE:
ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
[name=<generated>] Name of the cluster
version Redis version of the cluster
version Redis™ engine version of the cluster
[tags.{index}] Tags to apply to the cluster
node-type Type of node to use for the cluster
user-name Name of the user created when the cluster is created
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USAGE:
scw redis cluster migrate <cluster-id ...> [arg=value ...]

ARGS:
[version] Redis version of the cluster
[version] Redis™ engine version of the cluster
[node-type] Type of node to use for the cluster
[cluster-size] Number of nodes for the cluster
cluster-id UUID of the cluster to update
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-redis-cluster-usage.golden
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
A Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
A Managed Database for Redis cluster is composed of one or more Nodes depending of the cluster_size setting.

USAGE:
scw redis cluster <command>
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-redis-setting-usage.golden
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Cluster Settings are tunables of Redis Cluster. Available settings depend on the Redis version.
Available Redis™ settings. Available settings depend on the Redis version.

USAGE:
scw redis setting <command>
Expand Down
4 changes: 2 additions & 2 deletions cmd/scw/testdata/test-all-usage-redis-usage.golden
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Database Redis API
Managed Database for Redis API

USAGE:
scw redis <command>
Expand All @@ -11,7 +11,7 @@ AVAILABLE COMMANDS:
endpoint Endpoints management commands
node-type Node Types management commands
setting Settings management commands
version Redis Version management commands
version Redis™ version management commands

FLAGS:
-h, --help help for redis
Expand Down
10 changes: 5 additions & 5 deletions cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List available Redis versions.
List available Redis versions.

USAGE:
scw redis version list [arg=value ...]

ARGS:
[include-disabled] Whether or not to include disabled Redis versions
[include-beta] Whether or not to include beta Redis versions
[include-deprecated] Whether or not to include deprecated Redis versions
[version-name] List Redis versions that match a given name pattern
[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
[version-name] 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 | pl-waw-1)

FLAGS:
Expand Down
4 changes: 2 additions & 2 deletions cmd/scw/testdata/test-all-usage-redis-version-usage.golden
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Redis versions powering your cluster.
Redis versions powering your cluster.

USAGE:
scw redis version <command>

AVAILABLE COMMANDS:
list List available Redis versions
list List available Redis versions

FLAGS:
-h, --help help for version
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-main-usage-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ AVAILABLE COMMANDS:
marketplace Marketplace API
object Object-storage utils
rdb Database RDB API
redis Database Redis API
redis Managed Database for Redis API
registry Container registry API
version Display cli version
vpc VPC API
Expand Down
30 changes: 15 additions & 15 deletions docs/commands/redis.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
# Documentation for `scw redis`
Database Redis API
Managed Database for Redis API

- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands)
- [Add ACL rules for a given cluster](#add-acl-rules-for-a-given-cluster)
Expand Down Expand Up @@ -28,8 +28,8 @@ Database Redis API
- [Add cluster settings](#add-cluster-settings)
- [Delete a cluster setting](#delete-a-cluster-setting)
- [Set cluster settings](#set-cluster-settings)
- [Redis Version management commands](#redis-version-management-commands)
- [List available Redis versions](#list-available-redis-versions)
- [Redis™ version management commands](#redis-version-management-commands)
- [List available Redis versions](#list-available-redis-versions)


## Access Control List (ACL) management commands
Expand Down Expand Up @@ -124,7 +124,7 @@ scw redis acl set [arg=value ...]

## Cluster management commands

A Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
A Managed Database for Redis cluster is composed of one or more Nodes depending of the cluster_size setting.



Expand All @@ -145,7 +145,7 @@ scw redis cluster create [arg=value ...]
|------|---|-------------|
| project-id | | Project ID to use. If none is passed the default project ID will be used |
| name | Default: `<generated>` | Name of the cluster |
| version | Required | Redis version of the cluster |
| version | Required | Redis™ engine version of the cluster |
| tags.{index} | | Tags to apply to the cluster |
| node-type | Required | Type of node to use for the cluster |
| user-name | Required | Name of the user created when the cluster is created |
Expand Down Expand Up @@ -284,7 +284,7 @@ scw redis cluster migrate <cluster-id ...> [arg=value ...]

| Name | | Description |
|------|---|-------------|
| version | | Redis version of the cluster |
| version | | Redis™ engine version of the cluster |
| node-type | | Type of node to use for the cluster |
| cluster-size | | Number of nodes for the cluster |
| cluster-id | Required | UUID of the cluster to update |
Expand Down Expand Up @@ -454,7 +454,7 @@ scw redis node-type list [arg=value ...]

## Settings management commands

Cluster Settings are tunables of Redis Cluster. Available settings depend on the Redis version.
Available Redis™ settings. Available settings depend on the Redis version.



Expand Down Expand Up @@ -523,14 +523,14 @@ scw redis setting set [arg=value ...]



## Redis Version management commands
## Redis™ version management commands

Redis versions powering your cluster.
Redis versions powering your cluster.


### List available Redis versions
### List available Redis versions

List available Redis versions.
List available Redis versions.

**Usage:**

Expand All @@ -543,10 +543,10 @@ scw redis version list [arg=value ...]

| Name | | Description |
|------|---|-------------|
| include-disabled | | Whether or not to include disabled Redis versions |
| include-beta | | Whether or not to include beta Redis versions |
| include-deprecated | | Whether or not to include deprecated Redis versions |
| version-name | | List Redis versions that match a given name pattern |
| 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 |
| version-name | | List Redis™ engine versions that match a given name pattern |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `pl-waw-1` | Zone to target. If none is passed will use default zone from the config |


Expand Down
26 changes: 13 additions & 13 deletions internal/namespaces/redis/v1alpha1/redis_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func GetGeneratedCommands() *core.Commands {
}
func redisRoot() *core.Command {
return &core.Command{
Short: `Database Redis API`,
Short: `Managed Database for Redis API`,
Long: ``,
Namespace: "redis",
}
Expand All @@ -61,7 +61,7 @@ func redisRoot() *core.Command {
func redisCluster() *core.Command {
return &core.Command{
Short: `Cluster management commands`,
Long: `A Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
Long: `A Managed Database for Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
`,
Namespace: "redis",
Resource: "cluster",
Expand All @@ -80,8 +80,8 @@ func redisNodeType() *core.Command {

func redisVersion() *core.Command {
return &core.Command{
Short: `Redis Version management commands`,
Long: `Redis versions powering your cluster.`,
Short: `Redis™ version management commands`,
Long: `Redis versions powering your cluster.`,
Namespace: "redis",
Resource: "version",
}
Expand All @@ -90,7 +90,7 @@ func redisVersion() *core.Command {
func redisSetting() *core.Command {
return &core.Command{
Short: `Settings management commands`,
Long: `Cluster Settings are tunables of Redis Cluster. Available settings depend on the Redis version.
Long: `Available Redis™ settings. Available settings depend on the Redis version.
`,
Namespace: "redis",
Resource: "setting",
Expand Down Expand Up @@ -138,7 +138,7 @@ func redisClusterCreate() *core.Command {
},
{
Name: "version",
Short: `Redis version of the cluster`,
Short: `Redis™ engine version of the cluster`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -403,7 +403,7 @@ func redisClusterMigrate() *core.Command {
ArgSpecs: core.ArgSpecs{
{
Name: "version",
Short: `Redis version of the cluster`,
Short: `Redis™ engine version of the cluster`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -559,8 +559,8 @@ func redisNodeTypeList() *core.Command {

func redisVersionList() *core.Command {
return &core.Command{
Short: `List available Redis versions`,
Long: `List available Redis versions.`,
Short: `List available Redis versions`,
Long: `List available Redis versions.`,
Namespace: "redis",
Resource: "version",
Verb: "list",
Expand All @@ -569,28 +569,28 @@ func redisVersionList() *core.Command {
ArgSpecs: core.ArgSpecs{
{
Name: "include-disabled",
Short: `Whether or not to include disabled Redis versions`,
Short: `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 versions`,
Short: `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 versions`,
Short: `Whether or not to include deprecated Redis™ engine versions`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "version-name",
Short: `List Redis versions that match a given name pattern`,
Short: `List Redis™ engine versions that match a given name pattern`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down

0 comments on commit 4b31b4a

Please sign in to comment.