From 3caed48b75e0dfdf675a0ec12d3d3dd28c803f88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Go=CC=88kc=CC=A7e=20Go=CC=88k=20Klingel?= Date: Thu, 7 Mar 2024 16:28:12 +0100 Subject: [PATCH 1/2] Edit command descriptions --- .../cmd/object-storage/credentials-group/delete/delete.go | 4 ++-- internal/cmd/object-storage/credentials-group/list/list.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/internal/cmd/object-storage/credentials-group/delete/delete.go b/internal/cmd/object-storage/credentials-group/delete/delete.go index 70bf2548a..bdc519414 100644 --- a/internal/cmd/object-storage/credentials-group/delete/delete.go +++ b/internal/cmd/object-storage/credentials-group/delete/delete.go @@ -29,8 +29,8 @@ type inputModel struct { func NewCmd() *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("delete %s", credentialsGroupIdArg), - Short: "Deletes a credentials group", - 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.", + Short: "Deletes a credentials group that holds Object Storage access credentials", + 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.", Args: args.SingleArg(credentialsGroupIdArg, utils.ValidateUUID), Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/object-storage/credentials-group/list/list.go b/internal/cmd/object-storage/credentials-group/list/list.go index 694406de0..135b969e4 100644 --- a/internal/cmd/object-storage/credentials-group/list/list.go +++ b/internal/cmd/object-storage/credentials-group/list/list.go @@ -29,8 +29,8 @@ type inputModel struct { func NewCmd() *cobra.Command { cmd := &cobra.Command{ Use: "list", - Short: "Lists all credentials groups", - Long: "Lists all credentials groups.", + Short: "Lists all credentials groups that hold Object Storage access credentials", + Long: "Lists all credentials groups that hold Object Storage access credentials.", Args: args.NoArgs, Example: examples.Build( examples.NewExample( From b2018d58a0fb56cc76c879890f4855d75863e16c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Go=CC=88kc=CC=A7e=20Go=CC=88k=20Klingel?= Date: Thu, 7 Mar 2024 18:05:04 +0100 Subject: [PATCH 2/2] Update docs --- docs/stackit_object-storage_credentials-group.md | 4 ++-- docs/stackit_object-storage_credentials-group_delete.md | 4 ++-- docs/stackit_object-storage_credentials-group_list.md | 4 ++-- docs/stackit_object-storage_credentials_create.md | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/stackit_object-storage_credentials-group.md b/docs/stackit_object-storage_credentials-group.md index d575dfde9..10f8390d6 100644 --- a/docs/stackit_object-storage_credentials-group.md +++ b/docs/stackit_object-storage_credentials-group.md @@ -29,6 +29,6 @@ stackit object-storage credentials-group [flags] * [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage * [stackit object-storage credentials-group create](./stackit_object-storage_credentials-group_create.md) - Creates a credentials group to hold Object Storage access credentials -* [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group -* [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups +* [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group that holds Object Storage access credentials +* [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups that hold Object Storage access credentials diff --git a/docs/stackit_object-storage_credentials-group_delete.md b/docs/stackit_object-storage_credentials-group_delete.md index 56a59ae5d..ca82db090 100644 --- a/docs/stackit_object-storage_credentials-group_delete.md +++ b/docs/stackit_object-storage_credentials-group_delete.md @@ -1,10 +1,10 @@ ## stackit object-storage credentials-group delete -Deletes a credentials group +Deletes a credentials group that holds Object Storage access credentials ### Synopsis -Deletes a credentials group. Only possible if there are no valid credentials (access-keys) left in the group, otherwise it will throw an error. +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. ``` stackit object-storage credentials-group delete CREDENTIALS_GROUP_ID [flags] diff --git a/docs/stackit_object-storage_credentials-group_list.md b/docs/stackit_object-storage_credentials-group_list.md index 6da01feff..e6e2b8761 100644 --- a/docs/stackit_object-storage_credentials-group_list.md +++ b/docs/stackit_object-storage_credentials-group_list.md @@ -1,10 +1,10 @@ ## stackit object-storage credentials-group list -Lists all credentials groups +Lists all credentials groups that hold Object Storage access credentials ### Synopsis -Lists all credentials groups. +Lists all credentials groups that hold Object Storage access credentials. ``` stackit object-storage credentials-group list [flags] diff --git a/docs/stackit_object-storage_credentials_create.md b/docs/stackit_object-storage_credentials_create.md index 92575660a..3cecb8be8 100644 --- a/docs/stackit_object-storage_credentials_create.md +++ b/docs/stackit_object-storage_credentials_create.md @@ -4,7 +4,7 @@ Creates credentials for an Object Storage credentials group ### Synopsis -Creates credentials for an Object Storage credentials group. The credentials are only displayed upon creation, and it will not be retrievable later. +Creates credentials for an Object Storage credentials group. The credentials are only displayed upon creation, and will not be retrievable later. ``` stackit object-storage credentials create [flags] @@ -13,10 +13,10 @@ stackit object-storage credentials create [flags] ### Examples ``` - Create credentials for a credentials group with ID xxx + Create credentials for a credentials group with ID "xxx" $ stackit object-storage credentials create --credentials-group-id xxx - Create credentials for a credentials group with ID xxx, including a specific expiration date + Create credentials for a credentials group with ID "xxx", including a specific expiration date $ stackit object-storage credentials create --credentials-group-id xxx --expire-date 2024-03-06T00:00:00.000Z ```