Skip to content

fix(secret-manager): incomplete API descriptions #2875

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 1 commit into from
Mar 16, 2023
Merged

fix(secret-manager): incomplete API descriptions #2875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion 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 @@ -6,7 +6,7 @@ USAGE:
scw secret secret create [arg=value ...]

EXAMPLES:
Add a given secret
Add a given Secret
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"

ARGS:
Expand Down
4 changes: 2 additions & 2 deletions cmd/scw/testdata/test-all-usage-secret-secret-delete-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a secret.
Delete a Secret.

USAGE:
scw secret secret delete [arg=value ...]

EXAMPLES:
Delete a given secret
Delete a given Secret
scw secret secret delete secret-id=11111111-1111-1111-1111-111111111111

ARGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-secret-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

AVAILABLE COMMANDS:
create Create a Secret containing no versions
delete Delete a secret
delete Delete a Secret
get Get metadata of a Secret
list List Secrets
update Update metadata of a Secret
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-delete-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USAGE:
scw secret version delete [arg=value ...]

EXAMPLES:
Delete a given Secret Version
Delete a given SecretVersion
scw secret version delete secret-id=11111111-1111-1111-1111-111111111111 revision=1

ARGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-version-list-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List versions of a secret, not returning any sensitive data.
List versions of a Secret, not returning any sensitive data.

USAGE:
scw secret version list [arg=value ...]
Expand Down
4 changes: 2 additions & 2 deletions cmd/scw/testdata/test-all-usage-secret-version-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Immutable version of a secret.
Immutable version of a Secret.

USAGE:
scw secret version <command>
Expand All @@ -12,7 +12,7 @@ AVAILABLE COMMANDS:
disable Disable a SecretVersion
enable Enable a SecretVersion
get Get metadata of a SecretVersion
list List versions of a secret, not returning any sensitive data
list List versions of a Secret, not returning any sensitive data
update Update metadata of a SecretVersion

FLAGS:
Expand Down
20 changes: 10 additions & 10 deletions docs/commands/secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Secret API (beta).

- [Secret management commands](#secret-management-commands)
- [Create a Secret containing no versions](#create-a-secret-containing-no-versions)
- [Delete a secret](#delete-a-secret)
- [Delete a Secret](#delete-a-secret)
- [Get metadata of a Secret](#get-metadata-of-a-secret)
- [List Secrets](#list-secrets)
- [Update metadata of a Secret](#update-metadata-of-a-secret)
Expand All @@ -15,7 +15,7 @@ Secret API (beta).
- [Disable a SecretVersion](#disable-a-secretversion)
- [Enable a SecretVersion](#enable-a-secretversion)
- [Get metadata of a SecretVersion](#get-metadata-of-a-secretversion)
- [List versions of a secret, not returning any sensitive data](#list-versions-of-a-secret,-not-returning-any-sensitive-data)
- [List versions of a Secret, not returning any sensitive data](#list-versions-of-a-secret,-not-returning-any-sensitive-data)
- [Update metadata of a SecretVersion](#update-metadata-of-a-secretversion)


Expand Down Expand Up @@ -50,17 +50,17 @@ scw secret secret create [arg=value ...]
**Examples:**


Add a given secret
Add a given Secret
```
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"
```




### Delete a secret
### Delete a Secret

Delete a secret.
Delete a Secret.

**Usage:**

Expand All @@ -80,7 +80,7 @@ scw secret secret delete [arg=value ...]
**Examples:**


Delete a given secret
Delete a given Secret
```
scw secret secret delete secret-id=11111111-1111-1111-1111-111111111111
```
Expand Down Expand Up @@ -157,7 +157,7 @@ scw secret secret update [arg=value ...]

## Secret Version management commands

Immutable version of a secret.
Immutable version of a Secret.



Expand Down Expand Up @@ -227,7 +227,7 @@ scw secret version delete [arg=value ...]
**Examples:**


Delete a given Secret Version
Delete a given SecretVersion
```
scw secret version delete secret-id=11111111-1111-1111-1111-111111111111 revision=1
```
Expand Down Expand Up @@ -298,9 +298,9 @@ scw secret version get [arg=value ...]



### List versions of a secret, not returning any sensitive data
### List versions of a Secret, not returning any sensitive data

List versions of a secret, not returning any sensitive data.
List versions of a Secret, not returning any sensitive data.

**Usage:**

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 @@ -19,7 +19,7 @@ require (
github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
github.com/mattn/go-colorable v0.1.13
github.com/mattn/go-isatty v0.0.17
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42
github.com/spf13/cobra v1.6.1
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.8.2
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 @@ -72,8 +72,8 @@ github.com/pkg/term v1.1.0/go.mod h1:E25nymQcrSllhX42Ok8MRm1+hyBdHY0dCeiKZ9jpNGw
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41 h1:D9rWQCzAaXoBOEQTnw+x5YI1JLZRj/ccKtT4u5DCC1E=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42 h1:8X7HJIk2/9N3PCt7jrp3DPLDr8ev3ilzJJaW+vx4LN4=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA=
Expand Down
16 changes: 8 additions & 8 deletions internal/namespaces/secret/v1alpha1/secret_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func secretSecret() *core.Command {
func secretVersion() *core.Command {
return &core.Command{
Short: `Secret Version management commands`,
Long: `Immutable version of a secret.
Long: `Immutable version of a Secret.
`,
Namespace: "secret",
Resource: "version",
Expand Down Expand Up @@ -109,7 +109,7 @@ func secretSecretCreate() *core.Command {
},
Examples: []*core.Example{
{
Short: "Add a given secret",
Short: "Add a given Secret",
Raw: `scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"`,
},
},
Expand Down Expand Up @@ -266,8 +266,8 @@ func secretSecretList() *core.Command {

func secretSecretDelete() *core.Command {
return &core.Command{
Short: `Delete a secret`,
Long: `Delete a secret.`,
Short: `Delete a Secret`,
Long: `Delete a Secret.`,
Namespace: "secret",
Resource: "secret",
Verb: "delete",
Expand Down Expand Up @@ -299,7 +299,7 @@ func secretSecretDelete() *core.Command {
},
Examples: []*core.Example{
{
Short: "Delete a given secret",
Short: "Delete a given Secret",
ArgsJSON: `{"secret_id":"11111111-1111-1111-1111-111111111111"}`,
},
},
Expand Down Expand Up @@ -433,8 +433,8 @@ func secretVersionUpdate() *core.Command {

func secretVersionList() *core.Command {
return &core.Command{
Short: `List versions of a secret, not returning any sensitive data`,
Long: `List versions of a secret, not returning any sensitive data.`,
Short: `List versions of a Secret, not returning any sensitive data`,
Long: `List versions of a Secret, not returning any sensitive data.`,
Namespace: "secret",
Resource: "version",
Verb: "list",
Expand Down Expand Up @@ -514,7 +514,7 @@ func secretVersionDelete() *core.Command {
},
Examples: []*core.Example{
{
Short: "Delete a given Secret Version",
Short: "Delete a given SecretVersion",
ArgsJSON: `{"revision":"1","secret_id":"11111111-1111-1111-1111-111111111111"}`,
},
},
Expand Down