Skip to content

docs(secret_manager): update documentation about key_id #4678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 22, 2025
Merged

docs(secret_manager): update documentation about key_id #4678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c4fec2f
feat: update generated APIs
scaleway-bot Apr 17, 2025
82dacc3
Merge branch 'master' into v1.6428.0
jremy42 Apr 18, 2025
5832ee4
fix import
jremy42 Apr 22, 2025
acf56ec
Merge branch 'master' into v1.6428.0
jremy42 Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/scw/testdata/test-all-usage-secret-secret-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ ARGS:
[ephemeral-policy.time-to-live] Time frame, from one second and up to one year, during which the secret's versions are valid.
[ephemeral-policy.expires-once-accessed] Returns `true` if the version expires after a single user access.
[ephemeral-policy.action] Action to perform when the version of a secret expires (unknown_action | delete | disable)
[protected] Returns `true` if secret protection is enabled on a given secret
[key-id] The Scaleway's Key Manager key ID
[protected] Returns `true` if secret protection is applied to a given secret
[key-id] ID of the Scaleway Key Manager key
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ scw secret secret create [arg=value ...]
| ephemeral-policy.time-to-live | | Time frame, from one second and up to one year, during which the secret's versions are valid. |
| ephemeral-policy.expires-once-accessed | | Returns `true` if the version expires after a single user access. |
| ephemeral-policy.action | One of: `unknown_action`, `delete`, `disable` | Action to perform when the version of a secret expires |
| protected | | Returns `true` if secret protection is enabled on a given secret |
| key-id | | The Scaleway's Key Manager key ID |
| protected | | Returns `true` if secret protection is applied to a given secret |
| key-id | | ID of the Scaleway Key Manager key |
| 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 |


Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ require (
github.com/mattn/go-isatty v0.0.20
github.com/moby/buildkit v0.13.2
github.com/opencontainers/go-digest v1.0.0
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250415141343-ed7d8fa2ef23
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250417091007-4d879045bf57
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
github.com/spf13/cobra v1.9.1
github.com/spf13/pflag v1.0.6
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,8 +462,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250415141343-ed7d8fa2ef23 h1:ahwe042nQ9ZfsUnoMIAvzctygyQAAu7sdVXswFP2KT8=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250415141343-ed7d8fa2ef23/go.mod h1:w4o02EHpO0CBGy2nehzWRaFQKd62G9HIf+Q07PDaUcE=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250417091007-4d879045bf57 h1:4whrhv1ujBRUmqKPPg/qe6LoweqTNYx7TLdgPUaQzM4=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250417091007-4d879045bf57/go.mod h1:w4o02EHpO0CBGy2nehzWRaFQKd62G9HIf+Q07PDaUcE=
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=
Expand Down
4 changes: 2 additions & 2 deletions internal/namespaces/secret/v1beta1/secret_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,14 @@ func secretSecretCreate() *core.Command {
},
{
Name: "protected",
Short: `Returns ` + "`" + `true` + "`" + ` if secret protection is enabled on a given secret`,
Short: `Returns ` + "`" + `true` + "`" + ` if secret protection is applied to a given secret`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "key-id",
Short: `The Scaleway's Key Manager key ID`,
Short: `ID of the Scaleway Key Manager key`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down
Loading