Skip to content

Commit 30fcb4a

Browse files
authored
fix(secret): remake examples (#2881)
1 parent aeb33a7 commit 30fcb4a

File tree

6 files changed

+26
-6
lines changed

6 files changed

+26
-6
lines changed

cmd/scw/testdata/test-all-usage-secret-secret-create-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ USAGE:
77

88
EXAMPLES:
99
Add a given Secret
10-
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"
10+
scw secret secret create project-id=<your-project-id> name="foobar" description="bar"
1111

1212
ARGS:
1313
[project-id] Project ID to use. If none is passed the default project ID will be used

cmd/scw/testdata/test-all-usage-secret-version-create-usage.golden

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Create a SecretVersion.
55
USAGE:
66
scw secret version create [arg=value ...]
77

8+
EXAMPLES:
9+
Add a given Secret Version
10+
scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>
11+
812
ARGS:
913
secret-id ID of the Secret
1014
data Content of the secret version. Base64 is handled by the SDK (Support file loading with @/path/to/file)

docs/commands/secret.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ scw secret secret create [arg=value ...]
5252

5353
Add a given Secret
5454
```
55-
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"
55+
scw secret secret create project-id=<your-project-id> name="foobar" description="bar"
5656
```
5757

5858

@@ -203,6 +203,16 @@ scw secret version create [arg=value ...]
203203
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
204204

205205

206+
**Examples:**
207+
208+
209+
Add a given Secret Version
210+
```
211+
scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>
212+
```
213+
214+
215+
206216

207217
### Destroy a SecretVersion, permanently destroying the sensitive data
208218

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ require (
1919
github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
2020
github.com/mattn/go-colorable v0.1.13
2121
github.com/mattn/go-isatty v0.0.17
22-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42
22+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02
2323
github.com/spf13/cobra v1.6.1
2424
github.com/spf13/pflag v1.0.5
2525
github.com/stretchr/testify v1.8.2

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ github.com/pkg/term v1.1.0/go.mod h1:E25nymQcrSllhX42Ok8MRm1+hyBdHY0dCeiKZ9jpNGw
7272
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
7373
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
7474
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
75-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42 h1:8X7HJIk2/9N3PCt7jrp3DPLDr8ev3ilzJJaW+vx4LN4=
76-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
75+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02 h1:Ipdjm5oXQtzoHxsc1Pj7LqOlNJh5HrVb4R9TRpFiwKM=
76+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
7777
github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
7878
github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
7979
github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA=

internal/namespaces/secret/v1alpha1/secret_cli.go

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ func secretSecretCreate() *core.Command {
110110
Examples: []*core.Example{
111111
{
112112
Short: "Add a given Secret",
113-
Raw: `scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"`,
113+
Raw: `scw secret secret create project-id=<your-project-id> name="foobar" description="bar"`,
114114
},
115115
},
116116
}
@@ -347,6 +347,12 @@ func secretVersionCreate() *core.Command {
347347
return api.CreateSecretVersion(request)
348348

349349
},
350+
Examples: []*core.Example{
351+
{
352+
Short: "Add a given Secret Version",
353+
Raw: `scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>`,
354+
},
355+
},
350356
}
351357
}
352358

0 commit comments

Comments
 (0)