docs(redis): add documentation on endpoint (#2415)

Co-authored-by: Rémy Léone <[email protected]>

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-redis-endpoint-delete-usage.golden

@@ -6,7 +6,7 @@ USAGE:
   scw redis endpoint delete [arg=value ...]
 
 ARGS:
-  endpoint-id       
+  endpoint-id       UUID of the endpoint you want to delete
   [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:

cmd/scw/testdata/test-all-usage-redis-endpoint-get-usage.golden

@@ -3,10 +3,10 @@
 Get an endpoint.
 
 USAGE:
-  scw redis endpoint get [arg=value ...]
+  scw redis endpoint get <endpoint-id ...> [arg=value ...]
 
 ARGS:
-  endpoint-id       
+  endpoint-id       UUID of the endpoint you want to get
   [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:

docs/commands/redis.md

@@ -379,7 +379,7 @@ scw redis endpoint delete [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| endpoint-id | Required |  |
+| endpoint-id | Required | UUID of the endpoint you want to delete |
 | 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 |
 
 
@@ -391,15 +391,15 @@ Get an endpoint.
 **Usage:**
 
 ```
-scw redis endpoint get [arg=value ...]
+scw redis endpoint get <endpoint-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| endpoint-id | Required |  |
+| endpoint-id | Required | UUID of the endpoint you want to get |
 | 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 |
 
 

go.mod

@@ -17,7 +17,7 @@ require (
 	github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
 	github.com/mattn/go-colorable v0.1.12
 	github.com/mattn/go-isatty v0.0.14
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220707154924-556b07217bb3
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220707171016-83f8b0bacb31
 	github.com/spf13/cobra v1.5.0
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.8.0

go.sum

@@ -57,8 +57,8 @@ github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220707154924-556b07217bb3 h1:ySnHdnqH83uN6ZtKO/uKUsSLLx7K3UZPAv+C/fvAoHY=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220707154924-556b07217bb3/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220707171016-83f8b0bacb31 h1:xiYJc7OR9OrGHCT6Bluvr7hKz3Tc7AQK4iAuFlvMeOM=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220707171016-83f8b0bacb31/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
 github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
 github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
 github.com/spf13/cobra v1.5.0 h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=

internal/namespaces/redis/v1alpha1/redis_cli.go

@@ -1063,6 +1063,7 @@ func redisEndpointDelete() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "endpoint-id",
+				Short:      `UUID of the endpoint you want to delete`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -1098,9 +1099,10 @@ func redisEndpointGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "endpoint-id",
+				Short:      `UUID of the endpoint you want to get`,
 				Required:   true,
 				Deprecated: false,
-				Positional: false,
+				Positional: true,
 			},
 			core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneNlAms1, scw.ZonePlWaw1),
 		},