Skip to content

Edit object-storage credentials-group command descriptions #127

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 2 commits into from
Mar 8, 2024
Merged

Edit object-storage credentials-group command descriptions #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3caed48
Edit command descriptions
GokceGK Mar 7, 2024
b2018d5
Update docs
GokceGK Mar 7, 2024
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
4 changes: 2 additions & 2 deletions docs/stackit_object-storage_credentials-group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

4 changes: 2 additions & 2 deletions docs/stackit_object-storage_credentials-group_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_object-storage_credentials-group_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
6 changes: 3 additions & 3 deletions docs/stackit_object-storage_credentials_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
```

Expand Down
4 changes: 2 additions & 2 deletions internal/cmd/object-storage/credentials-group/delete/delete.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
4 changes: 2 additions & 2 deletions internal/cmd/object-storage/credentials-group/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down