fix name in example form --key-ring to correct --key-ring-id

Author: Jan Sternagel

internal/cmd/beta/kms/key/create/create.go

@@ -55,10 +55,10 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`Create a Symmetric KMS key`,
-				`$ stackit beta kms key create --key-ring "my-keyring-id" --algorithm "rsa_2048_oaep_sha256" --name "my-key-name" --purpose "asymmetric_encrypt_decrypt" --protection "software"`),
+				`$ stackit beta kms key create --key-ring-id "XXX" --algorithm "rsa_2048_oaep_sha256" --name "my-key-name" --purpose "asymmetric_encrypt_decrypt" --protection "software"`),
 			examples.NewExample(
 				`Create a Message Authentication KMS key`,
-				`$ stackit beta kms key create --key-ring "my-keyring-id" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code" --protection "software"`),
+				`$ stackit beta kms key create --key-ring-id "XXX" --algorithm "hmac_sha512" --name "my-key-name" --purpose "message_authentication_code" --protection "software"`),
 		),
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/key/delete/delete.go

@@ -42,7 +42,7 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`Delete a KMS key "my-key-id" inside the key ring "my-key-ring-id"`,
-				`$ stackit beta kms key delete "my-key-id" --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms key delete "my-key-id" --key-ring-id "my-key-ring-id"`),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/key/key.go

@@ -17,7 +17,7 @@ import (
 func NewCmd(params *params.CmdParams) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "key",
-		Short: "Manage KMS Keys",
+		Short: "Manage KMS keys",
 		Long:  "Provides functionality for key operations inside the KMS",
 		Args:  args.NoArgs,
 		Run:   utils.CmdHelp,

internal/cmd/beta/kms/key/list/list.go

@@ -38,10 +38,10 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`List all KMS keys for the key ring "my-key-ring-id"`,
-				`$ stackit beta kms key list --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms key list --key-ring-id "my-key-ring-id"`),
 			examples.NewExample(
 				`List all KMS keys in JSON format`,
-				`$ stackit beta kms key list --key-ring "my-key-ring-id" --output-format json`),
+				`$ stackit beta kms key list --key-ring-id "my-key-ring-id" --output-format json`),
 		),
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/key/restore/restore.go

@@ -42,7 +42,7 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`Restore a KMS key "my-key-id" inside the key ring "my-key-ring-id" that was scheduled for deletion.`,
-				`$ stackit beta kms keyring restore "my-key-id" --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms keyring restore "my-key-id" --key-ring-id "my-key-ring-id"`),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/key/rotate/rotate.go

@@ -42,7 +42,7 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`Rotate a KMS key "my-key-id" and increase it's version inside the key ring "my-key-ring-id".`,
-				`$ stackit beta kms key rotate "my-key-id" --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms key rotate "my-key-id" --key-ring-id "my-key-ring-id"`),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/version/destroy/destroy.go

@@ -43,7 +43,7 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`Destroy key version "42" for the key "my-key-id" inside the key ring "my-key-ring-id"`,
-				`$ stackit beta kms version destroy 42 --key "my-key-id" --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms version destroy 42 --key "my-key-id" --key-ring-id "my-key-ring-id"`),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/version/disable/disable.go

@@ -43,7 +43,7 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`Disable key version "42" for the key "my-key-id" inside the key ring "my-key-ring-id"`,
-				`$ stackit beta kms version disable 42 --key "my-key-id" --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms version disable 42 --key "my-key-id" --key-ring-id "my-key-ring-id"`),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/version/enable/enable.go

@@ -45,7 +45,7 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`Enable key version "42" for the key "my-key-id" inside the key ring "my-key-ring-id"`,
-				`$ stackit beta kms version enable 42 --key "my-key-id" --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms version enable 42 --key "my-key-id" --key-ring-id "my-key-ring-id"`),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

internal/cmd/beta/kms/version/list/list.go

@@ -40,10 +40,10 @@ func NewCmd(params *params.CmdParams) *cobra.Command {
 		Example: examples.Build(
 			examples.NewExample(
 				`List all key versions for the key "my-key-id" inside the key ring "my-key-ring-id"`,
-				`$ stackit beta kms version list --key "my-key-id" --key-ring "my-key-ring-id"`),
+				`$ stackit beta kms version list --key "my-key-id" --key-ring-id "my-key-ring-id"`),
 			examples.NewExample(
 				`List all key versions in JSON format`,
-				`$ stackit beta kms version list --key "my-key-id" --key-ring "my-key-ring-id" -o json`),
+				`$ stackit beta kms version list --key "my-key-id" --key-ring-id "my-key-ring-id" -o json`),
 		),
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			ctx := context.Background()