Skip to content

Commit 4cfc37f

Browse files
authored
feat(secret-manager): add endpoints for using name to retrieve secrets (#2781)
1 parent d80db2f commit 4cfc37f

File tree

7 files changed

+48
-3
lines changed

7 files changed

+48
-3
lines changed

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

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

88
ARGS:
99
secret-id ID of the Secret
10+
[secret-name] Name of the Secret (alternative to secret_id)
1011
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1112

1213
FLAGS:

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ USAGE:
88
ARGS:
99
[project-id] ID of a project to filter on (optional)
1010
[tags.{index}] List of tags to filter on (optional)
11+
[name] Name of the secrets (optional)
1112
[order-by] (name_asc | name_desc | created_at_asc | created_at_desc | updated_at_asc | updated_at_desc)
1213
[organization-id] ID of an organization to filter on (optional)
1314
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)

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

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

88
ARGS:
99
secret-id ID of the Secret
10-
revision Revision of the SecretVersion (may be a number or "latest")
10+
[secret-name] Name of the Secret (alternative to secret_id)
11+
revision Revision of the SecretVersion (may be a number, "latest" or "latest_enabled")
1112
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1213

1314
FLAGS:

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

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

88
ARGS:
99
secret-id ID of the Secret
10+
[secret-name] Name of the Secret (alternative to secret_id)
1011
revision Revision of the SecretVersion (may be a number or "latest")
1112
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1213

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

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

88
ARGS:
99
secret-id ID of the Secret
10+
[secret-name] Name of the Secret (alternative to secret_id)
1011
[status.{index}] Filter results by status (unknown | enabled | disabled | destroyed)
1112
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
1213

docs/commands/secret.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ scw secret secret get [arg=value ...]
104104
| Name | | Description |
105105
|------|---|-------------|
106106
| secret-id | Required | ID of the Secret |
107+
| secret-name | | Name of the Secret (alternative to secret_id) |
107108
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
108109

109110

@@ -125,6 +126,7 @@ scw secret secret list [arg=value ...]
125126
|------|---|-------------|
126127
| project-id | | ID of a project to filter on (optional) |
127128
| tags.{index} | | List of tags to filter on (optional) |
129+
| name | | Name of the secrets (optional) |
128130
| order-by | One of: `name_asc`, `name_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc` | |
129131
| organization-id | | ID of an organization to filter on (optional) |
130132
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |
@@ -176,7 +178,8 @@ scw secret version access [arg=value ...]
176178
| Name | | Description |
177179
|------|---|-------------|
178180
| secret-id | Required | ID of the Secret |
179-
| revision | Required | Revision of the SecretVersion (may be a number or "latest") |
181+
| secret-name | | Name of the Secret (alternative to secret_id) |
182+
| revision | Required | Revision of the SecretVersion (may be a number, "latest" or "latest_enabled") |
180183
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
181184

182185

@@ -292,6 +295,7 @@ scw secret version get [arg=value ...]
292295
| Name | | Description |
293296
|------|---|-------------|
294297
| secret-id | Required | ID of the Secret |
298+
| secret-name | | Name of the Secret (alternative to secret_id) |
295299
| revision | Required | Revision of the SecretVersion (may be a number or "latest") |
296300
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
297301

@@ -313,6 +317,7 @@ scw secret version list [arg=value ...]
313317
| Name | | Description |
314318
|------|---|-------------|
315319
| secret-id | Required | ID of the Secret |
320+
| secret-name | | Name of the Secret (alternative to secret_id) |
316321
| status.{index} | One of: `unknown`, `enabled`, `disabled`, `destroyed` | Filter results by status |
317322
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |
318323

internal/namespaces/secret/v1alpha1/secret_cli.go

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,13 @@ func secretSecretGet() *core.Command {
133133
Deprecated: false,
134134
Positional: false,
135135
},
136+
{
137+
Name: "secret-name",
138+
Short: `Name of the Secret (alternative to secret_id)`,
139+
Required: false,
140+
Deprecated: false,
141+
Positional: false,
142+
},
136143
core.RegionArgSpec(scw.RegionFrPar),
137144
},
138145
Run: func(ctx context.Context, args interface{}) (i interface{}, e error) {
@@ -221,6 +228,13 @@ func secretSecretList() *core.Command {
221228
Deprecated: false,
222229
Positional: false,
223230
},
231+
{
232+
Name: "name",
233+
Short: `Name of the secrets (optional)`,
234+
Required: false,
235+
Deprecated: false,
236+
Positional: false,
237+
},
224238
{
225239
Name: "order-by",
226240
Required: false,
@@ -377,6 +391,13 @@ func secretVersionGet() *core.Command {
377391
Deprecated: false,
378392
Positional: false,
379393
},
394+
{
395+
Name: "secret-name",
396+
Short: `Name of the Secret (alternative to secret_id)`,
397+
Required: false,
398+
Deprecated: false,
399+
Positional: false,
400+
},
380401
{
381402
Name: "revision",
382403
Short: `Revision of the SecretVersion (may be a number or "latest")`,
@@ -458,6 +479,13 @@ func secretVersionList() *core.Command {
458479
Deprecated: false,
459480
Positional: false,
460481
},
482+
{
483+
Name: "secret-name",
484+
Short: `Name of the Secret (alternative to secret_id)`,
485+
Required: false,
486+
Deprecated: false,
487+
Positional: false,
488+
},
461489
{
462490
Name: "status.{index}",
463491
Short: `Filter results by status`,
@@ -639,9 +667,16 @@ func secretVersionAccess() *core.Command {
639667
Deprecated: false,
640668
Positional: false,
641669
},
670+
{
671+
Name: "secret-name",
672+
Short: `Name of the Secret (alternative to secret_id)`,
673+
Required: false,
674+
Deprecated: false,
675+
Positional: false,
676+
},
642677
{
643678
Name: "revision",
644-
Short: `Revision of the SecretVersion (may be a number or "latest")`,
679+
Short: `Revision of the SecretVersion (may be a number, "latest" or "latest_enabled")`,
645680
Required: true,
646681
Deprecated: false,
647682
Positional: false,

0 commit comments

Comments
 (0)