Fix typos (#138)

GokceGK · web-flow · commit cf7445ea2e9a · 2024-03-11T14:56:12.000+01:00
* fix typos for secrets-manager

* fix typos for rabbitmq

* fix typos

* update docs
diff --git a/docs/stackit_rabbitmq_credentials.md b/docs/stackit_rabbitmq_credentials.md
@@ -28,8 +28,8 @@ stackit rabbitmq credentials [flags]
 ### SEE ALSO
 
 * [stackit rabbitmq](./stackit_rabbitmq.md)	 - Provides functionality for RabbitMQ
-* [stackit rabbitmq credentials create](./stackit_rabbitmq_credentials_create.md)	 - Creates credentials for an RabbitMQ instance
-* [stackit rabbitmq credentials delete](./stackit_rabbitmq_credentials_delete.md)	 - Deletes credentials of an RabbitMQ instance
-* [stackit rabbitmq credentials describe](./stackit_rabbitmq_credentials_describe.md)	 - Shows details of credentials of an RabbitMQ instance
-* [stackit rabbitmq credentials list](./stackit_rabbitmq_credentials_list.md)	 - Lists all credentials' IDs for an RabbitMQ instance
+* [stackit rabbitmq credentials create](./stackit_rabbitmq_credentials_create.md)	 - Creates credentials for a RabbitMQ instance
+* [stackit rabbitmq credentials delete](./stackit_rabbitmq_credentials_delete.md)	 - Deletes credentials of a RabbitMQ instance
+* [stackit rabbitmq credentials describe](./stackit_rabbitmq_credentials_describe.md)	 - Shows details of credentials of a RabbitMQ instance
+* [stackit rabbitmq credentials list](./stackit_rabbitmq_credentials_list.md)	 - Lists all credentials' IDs for a RabbitMQ instance
 
diff --git a/docs/stackit_rabbitmq_credentials_create.md b/docs/stackit_rabbitmq_credentials_create.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq credentials create
 
-Creates credentials for an RabbitMQ instance
+Creates credentials for a RabbitMQ instance
 
 ### Synopsis
 
-Creates credentials (username and password) for an RabbitMQ instance.
+Creates credentials (username and password) for a RabbitMQ instance.
 
 ```
 stackit rabbitmq credentials create [flags]
@@ -13,10 +13,10 @@ stackit rabbitmq credentials create [flags]
 ### Examples
 
 ```
-  Create credentials for an RabbitMQ instance
+  Create credentials for a RabbitMQ instance
   $ stackit rabbitmq credentials create --instance-id xxx
 
-  Create credentials for an RabbitMQ instance and hide the password in the output
+  Create credentials for a RabbitMQ instance and hide the password in the output
   $ stackit rabbitmq credentials create --instance-id xxx --hide-password
 ```
 
diff --git a/docs/stackit_rabbitmq_credentials_delete.md b/docs/stackit_rabbitmq_credentials_delete.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq credentials delete
 
-Deletes credentials of an RabbitMQ instance
+Deletes credentials of a RabbitMQ instance
 
 ### Synopsis
 
-Deletes credentials of an RabbitMQ instance.
+Deletes credentials of a RabbitMQ instance.
 
 ```
 stackit rabbitmq credentials delete CREDENTIALS_ID [flags]
diff --git a/docs/stackit_rabbitmq_credentials_describe.md b/docs/stackit_rabbitmq_credentials_describe.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq credentials describe
 
-Shows details of credentials of an RabbitMQ instance
+Shows details of credentials of a RabbitMQ instance
 
 ### Synopsis
 
-Shows details of credentials of an RabbitMQ instance. The password will be shown in plain text in the output.
+Shows details of credentials of a RabbitMQ instance. The password will be shown in plain text in the output.
 
 ```
 stackit rabbitmq credentials describe CREDENTIALS_ID [flags]
diff --git a/docs/stackit_rabbitmq_credentials_list.md b/docs/stackit_rabbitmq_credentials_list.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq credentials list
 
-Lists all credentials' IDs for an RabbitMQ instance
+Lists all credentials' IDs for a RabbitMQ instance
 
 ### Synopsis
 
-Lists all credentials' IDs for an RabbitMQ instance.
+Lists all credentials' IDs for a RabbitMQ instance.
 
 ```
 stackit rabbitmq credentials list [flags]
@@ -13,13 +13,13 @@ stackit rabbitmq credentials list [flags]
 ### Examples
 
 ```
-  List all credentials' IDs for an RabbitMQ instance
+  List all credentials' IDs for a RabbitMQ instance
   $ stackit rabbitmq credentials list --instance-id xxx
 
-  List all credentials' IDs for an RabbitMQ instance in JSON format
+  List all credentials' IDs for a RabbitMQ instance in JSON format
   $ stackit rabbitmq credentials list --instance-id xxx --output-format json
 
-  List up to 10 credentials' IDs for an RabbitMQ instance
+  List up to 10 credentials' IDs for a RabbitMQ instance
   $ stackit rabbitmq credentials list --instance-id xxx --limit 10
 ```
 
diff --git a/docs/stackit_rabbitmq_instance.md b/docs/stackit_rabbitmq_instance.md
@@ -28,9 +28,9 @@ stackit rabbitmq instance [flags]
 ### SEE ALSO
 
 * [stackit rabbitmq](./stackit_rabbitmq.md)	 - Provides functionality for RabbitMQ
-* [stackit rabbitmq instance create](./stackit_rabbitmq_instance_create.md)	 - Creates an RabbitMQ instance
-* [stackit rabbitmq instance delete](./stackit_rabbitmq_instance_delete.md)	 - Deletes an RabbitMQ instance
-* [stackit rabbitmq instance describe](./stackit_rabbitmq_instance_describe.md)	 - Shows details  of an RabbitMQ instance
+* [stackit rabbitmq instance create](./stackit_rabbitmq_instance_create.md)	 - Creates a RabbitMQ instance
+* [stackit rabbitmq instance delete](./stackit_rabbitmq_instance_delete.md)	 - Deletes a RabbitMQ instance
+* [stackit rabbitmq instance describe](./stackit_rabbitmq_instance_describe.md)	 - Shows details of a RabbitMQ instance
 * [stackit rabbitmq instance list](./stackit_rabbitmq_instance_list.md)	 - Lists all RabbitMQ instances
-* [stackit rabbitmq instance update](./stackit_rabbitmq_instance_update.md)	 - Updates an RabbitMQ instance
+* [stackit rabbitmq instance update](./stackit_rabbitmq_instance_update.md)	 - Updates a RabbitMQ instance
 
diff --git a/docs/stackit_rabbitmq_instance_create.md b/docs/stackit_rabbitmq_instance_create.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq instance create
 
-Creates an RabbitMQ instance
+Creates a RabbitMQ instance
 
 ### Synopsis
 
-Creates an RabbitMQ instance.
+Creates a RabbitMQ instance.
 
 ```
 stackit rabbitmq instance create [flags]
@@ -13,13 +13,13 @@ stackit rabbitmq instance create [flags]
 ### Examples
 
 ```
-  Create an RabbitMQ instance with name "my-instance" and specify plan by name and version
+  Create a RabbitMQ instance with name "my-instance" and specify plan by name and version
   $ stackit rabbitmq instance create --name my-instance --plan-name stackit-rabbitmq-1.2.10-replica --version 3.10
 
-  Create an RabbitMQ instance with name "my-instance" and specify plan by ID
+  Create a RabbitMQ instance with name "my-instance" and specify plan by ID
   $ stackit rabbitmq instance create --name my-instance --plan-id xxx
 
-  Create an RabbitMQ instance with name "my-instance" and specify IP range which is allowed to access it
+  Create a RabbitMQ instance with name "my-instance" and specify IP range which is allowed to access it
   $ stackit rabbitmq instance create --name my-instance --plan-id xxx --acl 1.2.3.0/24
 ```
 
diff --git a/docs/stackit_rabbitmq_instance_delete.md b/docs/stackit_rabbitmq_instance_delete.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq instance delete
 
-Deletes an RabbitMQ instance
+Deletes a RabbitMQ instance
 
 ### Synopsis
 
-Deletes an RabbitMQ instance.
+Deletes a RabbitMQ instance.
 
 ```
 stackit rabbitmq instance delete INSTANCE_ID [flags]
@@ -13,7 +13,7 @@ stackit rabbitmq instance delete INSTANCE_ID [flags]
 ### Examples
 
 ```
-  Delete an RabbitMQ instance with ID "xxx"
+  Delete a RabbitMQ instance with ID "xxx"
   $ stackit rabbitmq instance delete xxx
 ```
 
diff --git a/docs/stackit_rabbitmq_instance_describe.md b/docs/stackit_rabbitmq_instance_describe.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq instance describe
 
-Shows details  of an RabbitMQ instance
+Shows details of a RabbitMQ instance
 
 ### Synopsis
 
-Shows details  of an RabbitMQ instance.
+Shows details of a RabbitMQ instance.
 
 ```
 stackit rabbitmq instance describe INSTANCE_ID [flags]
@@ -13,10 +13,10 @@ stackit rabbitmq instance describe INSTANCE_ID [flags]
 ### Examples
 
 ```
-  Get details of an RabbitMQ instance with ID "xxx"
+  Get details of a RabbitMQ instance with ID "xxx"
   $ stackit rabbitmq instance describe xxx
 
-  Get details of an RabbitMQ instance with ID "xxx" in a table format
+  Get details of a RabbitMQ instance with ID "xxx" in a table format
   $ stackit rabbitmq instance describe xxx --output-format pretty
 ```
 
diff --git a/docs/stackit_rabbitmq_instance_update.md b/docs/stackit_rabbitmq_instance_update.md
@@ -1,10 +1,10 @@
 ## stackit rabbitmq instance update
 
-Updates an RabbitMQ instance
+Updates a RabbitMQ instance
 
 ### Synopsis
 
-Updates an RabbitMQ instance.
+Updates a RabbitMQ instance.
 
 ```
 stackit rabbitmq instance update INSTANCE_ID [flags]
@@ -13,10 +13,10 @@ stackit rabbitmq instance update INSTANCE_ID [flags]
 ### Examples
 
 ```
-  Update the plan of an RabbitMQ instance with ID "xxx"
+  Update the plan of a RabbitMQ instance with ID "xxx"
   $ stackit rabbitmq instance update xxx --plan-id yyy
 
-  Update the range of IPs allowed to access an RabbitMQ instance with ID "xxx"
+  Update the range of IPs allowed to access a RabbitMQ instance with ID "xxx"
   $ stackit rabbitmq instance update xxx --acl 1.2.3.0/24
 ```
 
diff --git a/docs/stackit_secrets-manager_user_list.md b/docs/stackit_secrets-manager_user_list.md
@@ -13,10 +13,10 @@ stackit secrets-manager user list [flags]
 ### Examples
 
 ```
-  List all Secrets Manager users of instance with ID "xxx
+  List all Secrets Manager users of instance with ID "xxx"
   $ stackit secrets-manager user list --instance-id xxx
 
-  List all Secrets Manager users in JSON format with ID "xxx
+  List all Secrets Manager users in JSON format with ID "xxx"
   $ stackit secrets-manager user list --instance-id xxx --output-format json
 
   List up to 10 Secrets Manager users with ID "xxx"
diff --git a/internal/cmd/logme/credentials/list/list.go b/internal/cmd/logme/credentials/list/list.go
@@ -63,7 +63,7 @@ func NewCmd() *cobra.Command {
 			req := buildRequest(ctx, model, apiClient)
 			resp, err := req.Execute()
 			if err != nil {
-				return fmt.Errorf("list LogMe credentialss: %w", err)
+				return fmt.Errorf("list LogMe credentials: %w", err)
 			}
 			credentials := *resp.CredentialsList
 			if len(credentials) == 0 {
diff --git a/internal/cmd/mariadb/credentials/list/list.go b/internal/cmd/mariadb/credentials/list/list.go
@@ -63,7 +63,7 @@ func NewCmd() *cobra.Command {
 			req := buildRequest(ctx, model, apiClient)
 			resp, err := req.Execute()
 			if err != nil {
-				return fmt.Errorf("list MariaDB credentialss: %w", err)
+				return fmt.Errorf("list MariaDB credentials: %w", err)
 			}
 			credentials := *resp.CredentialsList
 			if len(credentials) == 0 {
diff --git a/internal/cmd/opensearch/credentials/list/list.go b/internal/cmd/opensearch/credentials/list/list.go
@@ -63,7 +63,7 @@ func NewCmd() *cobra.Command {
 			req := buildRequest(ctx, model, apiClient)
 			resp, err := req.Execute()
 			if err != nil {
-				return fmt.Errorf("list OpenSearch credentialss: %w", err)
+				return fmt.Errorf("list OpenSearch credentials: %w", err)
 			}
 			credentials := *resp.CredentialsList
 			if len(credentials) == 0 {
diff --git a/internal/cmd/rabbitmq/credentials/create/create.go b/internal/cmd/rabbitmq/credentials/create/create.go
@@ -31,15 +31,15 @@ type inputModel struct {
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "create",
-		Short: "Creates credentials for an RabbitMQ instance",
-		Long:  "Creates credentials (username and password) for an RabbitMQ instance.",
+		Short: "Creates credentials for a RabbitMQ instance",
+		Long:  "Creates credentials (username and password) for a RabbitMQ instance.",
 		Args:  args.NoArgs,
 		Example: examples.Build(
 			examples.NewExample(
-				`Create credentials for an RabbitMQ instance`,
+				`Create credentials for a RabbitMQ instance`,
 				"$ stackit rabbitmq credentials create --instance-id xxx"),
 			examples.NewExample(
-				`Create credentials for an RabbitMQ instance and hide the password in the output`,
+				`Create credentials for a RabbitMQ instance and hide the password in the output`,
 				"$ stackit rabbitmq credentials create --instance-id xxx --hide-password"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/rabbitmq/credentials/delete/delete.go b/internal/cmd/rabbitmq/credentials/delete/delete.go
@@ -33,8 +33,8 @@ type inputModel struct {
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   fmt.Sprintf("delete %s", credentialsIdArg),
-		Short: "Deletes credentials of an RabbitMQ instance",
-		Long:  "Deletes credentials of an RabbitMQ instance.",
+		Short: "Deletes credentials of a RabbitMQ instance",
+		Long:  "Deletes credentials of a RabbitMQ instance.",
 		Args:  args.SingleArg(credentialsIdArg, utils.ValidateUUID),
 		Example: examples.Build(
 			examples.NewExample(
diff --git a/internal/cmd/rabbitmq/credentials/describe/describe.go b/internal/cmd/rabbitmq/credentials/describe/describe.go
@@ -33,8 +33,8 @@ type inputModel struct {
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   fmt.Sprintf("describe %s", credentialsIdArg),
-		Short: "Shows details of credentials of an RabbitMQ instance",
-		Long:  "Shows details of credentials of an RabbitMQ instance. The password will be shown in plain text in the output.",
+		Short: "Shows details of credentials of a RabbitMQ instance",
+		Long:  "Shows details of credentials of a RabbitMQ instance. The password will be shown in plain text in the output.",
 		Args:  args.SingleArg(credentialsIdArg, utils.ValidateUUID),
 		Example: examples.Build(
 			examples.NewExample(
diff --git a/internal/cmd/rabbitmq/credentials/list/list.go b/internal/cmd/rabbitmq/credentials/list/list.go
@@ -32,18 +32,18 @@ type inputModel struct {
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "list",
-		Short: "Lists all credentials' IDs for an RabbitMQ instance",
-		Long:  "Lists all credentials' IDs for an RabbitMQ instance.",
+		Short: "Lists all credentials' IDs for a RabbitMQ instance",
+		Long:  "Lists all credentials' IDs for a RabbitMQ instance.",
 		Args:  args.NoArgs,
 		Example: examples.Build(
 			examples.NewExample(
-				`List all credentials' IDs for an RabbitMQ instance`,
+				`List all credentials' IDs for a RabbitMQ instance`,
 				"$ stackit rabbitmq credentials list --instance-id xxx"),
 			examples.NewExample(
-				`List all credentials' IDs for an RabbitMQ instance in JSON format`,
+				`List all credentials' IDs for a RabbitMQ instance in JSON format`,
 				"$ stackit rabbitmq credentials list --instance-id xxx --output-format json"),
 			examples.NewExample(
-				`List up to 10 credentials' IDs for an RabbitMQ instance`,
+				`List up to 10 credentials' IDs for a RabbitMQ instance`,
 				"$ stackit rabbitmq credentials list --instance-id xxx --limit 10"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -63,7 +63,7 @@ func NewCmd() *cobra.Command {
 			req := buildRequest(ctx, model, apiClient)
 			resp, err := req.Execute()
 			if err != nil {
-				return fmt.Errorf("list RabbitMQ credentialss: %w", err)
+				return fmt.Errorf("list RabbitMQ credentials: %w", err)
 			}
 			credentials := *resp.CredentialsList
 			if len(credentials) == 0 {
diff --git a/internal/cmd/rabbitmq/instance/create/create.go b/internal/cmd/rabbitmq/instance/create/create.go
@@ -58,18 +58,18 @@ type inputModel struct {
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "create",
-		Short: "Creates an RabbitMQ instance",
-		Long:  "Creates an RabbitMQ instance.",
+		Short: "Creates a RabbitMQ instance",
+		Long:  "Creates a RabbitMQ instance.",
 		Args:  args.NoArgs,
 		Example: examples.Build(
 			examples.NewExample(
-				`Create an RabbitMQ instance with name "my-instance" and specify plan by name and version`,
+				`Create a RabbitMQ instance with name "my-instance" and specify plan by name and version`,
 				"$ stackit rabbitmq instance create --name my-instance --plan-name stackit-rabbitmq-1.2.10-replica --version 3.10"),
 			examples.NewExample(
-				`Create an RabbitMQ instance with name "my-instance" and specify plan by ID`,
+				`Create a RabbitMQ instance with name "my-instance" and specify plan by ID`,
 				"$ stackit rabbitmq instance create --name my-instance --plan-id xxx"),
 			examples.NewExample(
-				`Create an RabbitMQ instance with name "my-instance" and specify IP range which is allowed to access it`,
+				`Create a RabbitMQ instance with name "my-instance" and specify IP range which is allowed to access it`,
 				"$ stackit rabbitmq instance create --name my-instance --plan-id xxx --acl 1.2.3.0/24"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/rabbitmq/instance/delete/delete.go b/internal/cmd/rabbitmq/instance/delete/delete.go
@@ -31,12 +31,12 @@ type inputModel struct {
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   fmt.Sprintf("delete %s", instanceIdArg),
-		Short: "Deletes an RabbitMQ instance",
-		Long:  "Deletes an RabbitMQ instance.",
+		Short: "Deletes a RabbitMQ instance",
+		Long:  "Deletes a RabbitMQ instance.",
 		Args:  args.SingleArg(instanceIdArg, utils.ValidateUUID),
 		Example: examples.Build(
 			examples.NewExample(
-				`Delete an RabbitMQ instance with ID "xxx"`,
+				`Delete a RabbitMQ instance with ID "xxx"`,
 				"$ stackit rabbitmq instance delete xxx"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/rabbitmq/instance/describe/describe.go b/internal/cmd/rabbitmq/instance/describe/describe.go
@@ -31,15 +31,15 @@ type inputModel struct {
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   fmt.Sprintf("describe %s", instanceIdArg),
-		Short: "Shows details  of an RabbitMQ instance",
-		Long:  "Shows details  of an RabbitMQ instance.",
+		Short: "Shows details of a RabbitMQ instance",
+		Long:  "Shows details of a RabbitMQ instance.",
 		Args:  args.SingleArg(instanceIdArg, utils.ValidateUUID),
 		Example: examples.Build(
 			examples.NewExample(
-				`Get details of an RabbitMQ instance with ID "xxx"`,
+				`Get details of a RabbitMQ instance with ID "xxx"`,
 				"$ stackit rabbitmq instance describe xxx"),
 			examples.NewExample(
-				`Get details of an RabbitMQ instance with ID "xxx" in a table format`,
+				`Get details of a RabbitMQ instance with ID "xxx" in a table format`,
 				"$ stackit rabbitmq instance describe xxx --output-format pretty"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/rabbitmq/instance/update/update.go b/internal/cmd/rabbitmq/instance/update/update.go
diff --git a/internal/cmd/redis/credentials/list/list.go b/internal/cmd/redis/credentials/list/list.go
diff --git a/internal/cmd/secrets-manager/user/list/list.go b/internal/cmd/secrets-manager/user/list/list.go
