Skip to content

Commit 5fb212e

Browse files
authored
docs(secret_manager): update documentation for scheduled deletion (scaleway#4562)
1 parent 6b467fa commit 5fb212e

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ARGS:
1313
[path] Filter by exact path (optional)
1414
[ephemeral] Filter by ephemeral / not ephemeral (optional)
1515
[type] Filter by secret type (optional) (unknown_type | opaque | certificate | key_value | basic_credentials | database_credentials | ssh_key)
16-
[scheduled-for-deletion] Filter by whether the secret was scheduled for deletion / not scheduled for deletion (optional)
16+
[scheduled-for-deletion] Filter by whether the secret was scheduled for deletion / not scheduled for deletion. By default, it will display only not scheduled for deletion secrets.
1717
[organization-id] Filter by Organization ID (optional)
1818
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
1919

docs/commands/secret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ scw secret secret list [arg=value ...]
160160
| path | | Filter by exact path (optional) |
161161
| ephemeral | | Filter by ephemeral / not ephemeral (optional) |
162162
| type | One of: `unknown_type`, `opaque`, `certificate`, `key_value`, `basic_credentials`, `database_credentials`, `ssh_key` | Filter by secret type (optional) |
163-
| scheduled-for-deletion | | Filter by whether the secret was scheduled for deletion / not scheduled for deletion (optional) |
163+
| scheduled-for-deletion | | Filter by whether the secret was scheduled for deletion / not scheduled for deletion. By default, it will display only not scheduled for deletion secrets. |
164164
| organization-id | | Filter by Organization ID (optional) |
165165
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
166166

internal/namespaces/secret/v1beta1/secret_cli.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ func secretSecretList() *core.Command {
376376
},
377377
{
378378
Name: "scheduled-for-deletion",
379-
Short: `Filter by whether the secret was scheduled for deletion / not scheduled for deletion (optional)`,
379+
Short: `Filter by whether the secret was scheduled for deletion / not scheduled for deletion. By default, it will display only not scheduled for deletion secrets.`,
380380
Required: false,
381381
Deprecated: false,
382382
Positional: false,

0 commit comments

Comments
 (0)