Skip to content

Commit f34eac1

Browse files
authored
docs(secret-manager): update description (#2997)
1 parent ea01065 commit f34eac1

8 files changed

+22
-26
lines changed

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

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

88
ARGS:
99
secret-id ID of the secret
10-
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
10+
revision Version number
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1212

1313
FLAGS:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ EXAMPLES:
1111

1212
ARGS:
1313
secret-id ID of the secret
14-
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
14+
revision Version number
1515
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1616

1717
FLAGS:

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

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

88
ARGS:
99
secret-id ID of the secret
10-
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
10+
revision Version number
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1212

1313
FLAGS:

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

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

88
ARGS:
99
secret-id ID of the secret
10-
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
10+
revision Version number
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1212

1313
FLAGS:

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

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

88
ARGS:
99
secret-id ID of the secret
10-
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
10+
revision Version number
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1212

1313
FLAGS:

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

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

88
ARGS:
99
secret-id ID of the secret
10-
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
10+
revision Version number
1111
[description] Description of the version
1212
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1313

docs/commands/secret.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ Secret Manager API documentation.
2424
Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.
2525

2626

27-
2827
### Create a secret
2928

3029
You must sepcify the `region` to create a secret.
@@ -160,7 +159,6 @@ scw secret secret update [arg=value ...]
160159
Versions store the sensitive data contained in your secrets (API keys, passwords, or certificates).
161160

162161

163-
164162
### Access a secret's version using the secret's ID
165163

166164
Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters.
@@ -177,7 +175,7 @@ scw secret version access [arg=value ...]
177175
| Name | | Description |
178176
|------|---|-------------|
179177
| secret-id | Required | ID of the secret |
180-
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
178+
| revision | Required | Version number |
181179
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
182180

183181

@@ -226,7 +224,7 @@ scw secret version delete [arg=value ...]
226224
| Name | | Description |
227225
|------|---|-------------|
228226
| secret-id | Required | ID of the secret |
229-
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
227+
| revision | Required | Version number |
230228
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
231229

232230

@@ -257,7 +255,7 @@ scw secret version disable [arg=value ...]
257255
| Name | | Description |
258256
|------|---|-------------|
259257
| secret-id | Required | ID of the secret |
260-
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
258+
| revision | Required | Version number |
261259
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
262260

263261

@@ -278,7 +276,7 @@ scw secret version enable [arg=value ...]
278276
| Name | | Description |
279277
|------|---|-------------|
280278
| secret-id | Required | ID of the secret |
281-
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
279+
| revision | Required | Version number |
282280
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
283281

284282

@@ -299,7 +297,7 @@ scw secret version get [arg=value ...]
299297
| Name | | Description |
300298
|------|---|-------------|
301299
| secret-id | Required | ID of the secret |
302-
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
300+
| revision | Required | Version number |
303301
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
304302

305303

@@ -341,7 +339,7 @@ scw secret version update [arg=value ...]
341339
| Name | | Description |
342340
|------|---|-------------|
343341
| secret-id | Required | ID of the secret |
344-
| revision | Required | Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest" |
342+
| revision | Required | Version number |
345343
| description | | Description of the version |
346344
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
347345

internal/namespaces/secret/v1alpha1/secret_cli.go

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,17 @@ func secretRoot() *core.Command {
4747

4848
func secretSecret() *core.Command {
4949
return &core.Command{
50-
Short: `Secret management commands`,
51-
Long: `Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.
52-
`,
50+
Short: `Secret management commands`,
51+
Long: `Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.`,
5352
Namespace: "secret",
5453
Resource: "secret",
5554
}
5655
}
5756

5857
func secretVersion() *core.Command {
5958
return &core.Command{
60-
Short: `Secret Version management commands`,
61-
Long: `Versions store the sensitive data contained in your secrets (API keys, passwords, or certificates).
62-
`,
59+
Short: `Secret Version management commands`,
60+
Long: `Versions store the sensitive data contained in your secrets (API keys, passwords, or certificates).`,
6361
Namespace: "secret",
6462
Resource: "version",
6563
}
@@ -411,7 +409,7 @@ func secretVersionGet() *core.Command {
411409
},
412410
{
413411
Name: "revision",
414-
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
412+
Short: `Version number`,
415413
Required: true,
416414
Deprecated: false,
417415
Positional: false,
@@ -448,7 +446,7 @@ func secretVersionUpdate() *core.Command {
448446
},
449447
{
450448
Name: "revision",
451-
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
449+
Short: `Version number`,
452450
Required: true,
453451
Deprecated: false,
454452
Positional: false,
@@ -539,7 +537,7 @@ func secretVersionDelete() *core.Command {
539537
},
540538
{
541539
Name: "revision",
542-
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
540+
Short: `Version number`,
543541
Required: true,
544542
Deprecated: false,
545543
Positional: false,
@@ -582,7 +580,7 @@ func secretVersionEnable() *core.Command {
582580
},
583581
{
584582
Name: "revision",
585-
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
583+
Short: `Version number`,
586584
Required: true,
587585
Deprecated: false,
588586
Positional: false,
@@ -619,7 +617,7 @@ func secretVersionDisable() *core.Command {
619617
},
620618
{
621619
Name: "revision",
622-
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
620+
Short: `Version number`,
623621
Required: true,
624622
Deprecated: false,
625623
Positional: false,
@@ -656,7 +654,7 @@ func secretVersionAccess() *core.Command {
656654
},
657655
{
658656
Name: "revision",
659-
Short: `Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"`,
657+
Short: `Version number`,
660658
Required: true,
661659
Deprecated: false,
662660
Positional: false,

0 commit comments

Comments
 (0)