Skip to content

Commit 058a4ca

Browse files
authored
Edit object-storage credentials-group command descriptions (#127)
* Edit command descriptions * Update docs
1 parent f6e7263 commit 058a4ca

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

docs/stackit_object-storage_credentials-group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ stackit object-storage credentials-group [flags]
2929

3030
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
3131
* [stackit object-storage credentials-group create](./stackit_object-storage_credentials-group_create.md) - Creates a credentials group to hold Object Storage access credentials
32-
* [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group
33-
* [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups
32+
* [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group that holds Object Storage access credentials
33+
* [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups that hold Object Storage access credentials
3434

docs/stackit_object-storage_credentials-group_delete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit object-storage credentials-group delete
22

3-
Deletes a credentials group
3+
Deletes a credentials group that holds Object Storage access credentials
44

55
### Synopsis
66

7-
Deletes a credentials group. Only possible if there are no valid credentials (access-keys) left in the group, otherwise it will throw an error.
7+
Deletes a credentials group that holds Object Storage access credentials. Only possible if there are no valid credentials (access-keys) left in the group, otherwise it will throw an error.
88

99
```
1010
stackit object-storage credentials-group delete CREDENTIALS_GROUP_ID [flags]

docs/stackit_object-storage_credentials-group_list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit object-storage credentials-group list
22

3-
Lists all credentials groups
3+
Lists all credentials groups that hold Object Storage access credentials
44

55
### Synopsis
66

7-
Lists all credentials groups.
7+
Lists all credentials groups that hold Object Storage access credentials.
88

99
```
1010
stackit object-storage credentials-group list [flags]

internal/cmd/object-storage/credentials-group/delete/delete.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ type inputModel struct {
2929
func NewCmd() *cobra.Command {
3030
cmd := &cobra.Command{
3131
Use: fmt.Sprintf("delete %s", credentialsGroupIdArg),
32-
Short: "Deletes a credentials group",
33-
Long: "Deletes a credentials group. Only possible if there are no valid credentials (access-keys) left in the group, otherwise it will throw an error.",
32+
Short: "Deletes a credentials group that holds Object Storage access credentials",
33+
Long: "Deletes a credentials group that holds Object Storage access credentials. Only possible if there are no valid credentials (access-keys) left in the group, otherwise it will throw an error.",
3434
Args: args.SingleArg(credentialsGroupIdArg, utils.ValidateUUID),
3535
Example: examples.Build(
3636
examples.NewExample(

internal/cmd/object-storage/credentials-group/list/list.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ type inputModel struct {
2929
func NewCmd() *cobra.Command {
3030
cmd := &cobra.Command{
3131
Use: "list",
32-
Short: "Lists all credentials groups",
33-
Long: "Lists all credentials groups.",
32+
Short: "Lists all credentials groups that hold Object Storage access credentials",
33+
Long: "Lists all credentials groups that hold Object Storage access credentials.",
3434
Args: args.NoArgs,
3535
Example: examples.Build(
3636
examples.NewExample(

0 commit comments

Comments
 (0)