Skip to content

Commit 76a5b31

Browse files
docs(secret_manager): update documentation about key_id (#4678)
Co-authored-by: Jonathan R. <[email protected]>
1 parent 6dbf9b2 commit 76a5b31

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ ARGS:
1919
[ephemeral-policy.time-to-live] Time frame, from one second and up to one year, during which the secret's versions are valid.
2020
[ephemeral-policy.expires-once-accessed] Returns `true` if the version expires after a single user access.
2121
[ephemeral-policy.action] Action to perform when the version of a secret expires (unknown_action | delete | disable)
22-
[protected] Returns `true` if secret protection is enabled on a given secret
23-
[key-id] The Scaleway's Key Manager key ID
22+
[protected] Returns `true` if secret protection is applied to a given secret
23+
[key-id] ID of the Scaleway Key Manager key
2424
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
2525

2626
FLAGS:

docs/commands/secret.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ scw secret secret create [arg=value ...]
7373
| ephemeral-policy.time-to-live | | Time frame, from one second and up to one year, during which the secret's versions are valid. |
7474
| ephemeral-policy.expires-once-accessed | | Returns `true` if the version expires after a single user access. |
7575
| ephemeral-policy.action | One of: `unknown_action`, `delete`, `disable` | Action to perform when the version of a secret expires |
76-
| protected | | Returns `true` if secret protection is enabled on a given secret |
77-
| key-id | | The Scaleway's Key Manager key ID |
76+
| protected | | Returns `true` if secret protection is applied to a given secret |
77+
| key-id | | ID of the Scaleway Key Manager key |
7878
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
7979

8080

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ require (
2323
github.com/mattn/go-isatty v0.0.20
2424
github.com/moby/buildkit v0.13.2
2525
github.com/opencontainers/go-digest v1.0.0
26-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250415141343-ed7d8fa2ef23
26+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250417091007-4d879045bf57
2727
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
2828
github.com/spf13/cobra v1.9.1
2929
github.com/spf13/pflag v1.0.6

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -462,8 +462,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
462462
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
463463
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
464464
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
465-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250415141343-ed7d8fa2ef23 h1:ahwe042nQ9ZfsUnoMIAvzctygyQAAu7sdVXswFP2KT8=
466-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250415141343-ed7d8fa2ef23/go.mod h1:w4o02EHpO0CBGy2nehzWRaFQKd62G9HIf+Q07PDaUcE=
465+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250417091007-4d879045bf57 h1:4whrhv1ujBRUmqKPPg/qe6LoweqTNYx7TLdgPUaQzM4=
466+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250417091007-4d879045bf57/go.mod h1:w4o02EHpO0CBGy2nehzWRaFQKd62G9HIf+Q07PDaUcE=
467467
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
468468
github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
469469
github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=

internal/namespaces/secret/v1beta1/secret_cli.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,14 +151,14 @@ func secretSecretCreate() *core.Command {
151151
},
152152
{
153153
Name: "protected",
154-
Short: `Returns ` + "`" + `true` + "`" + ` if secret protection is enabled on a given secret`,
154+
Short: `Returns ` + "`" + `true` + "`" + ` if secret protection is applied to a given secret`,
155155
Required: false,
156156
Deprecated: false,
157157
Positional: false,
158158
},
159159
{
160160
Name: "key-id",
161-
Short: `The Scaleway's Key Manager key ID`,
161+
Short: `ID of the Scaleway Key Manager key`,
162162
Required: false,
163163
Deprecated: false,
164164
Positional: false,

0 commit comments

Comments
 (0)