Fix: Inconsistent naming of "Key Pair"

- fix: flag --public-key in `$ stackit beta key-pair describe` shows all data when a --output-format is defined
- implement all suggested changes

Author: marceljk

docs/stackit_beta.md

@@ -40,7 +40,7 @@ stackit beta [flags]
 ### SEE ALSO
 
 * [stackit](./stackit.md)	 - Manage STACKIT resources using the command line
-* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for Keypairs
+* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for SSH Key Pairs
 * [stackit beta network](./stackit_beta_network.md)	 - Provides functionality for networks
 * [stackit beta network-area](./stackit_beta_network-area.md)	 - Provides functionality for STACKIT Network Area (SNA)
 * [stackit beta network-interface](./stackit_beta_network-interface.md)	 - Provides functionality for network interfaces

docs/stackit_beta_key-pair.md

@@ -1,10 +1,10 @@
 ## stackit beta key-pair
 
-Provides functionality for Keypairs
+Provides functionality for SSH Key Pairs
 
 ### Synopsis
 
-Provides functionality for Keypairs
+Provides functionality for SSH Key Pairs
 
 ```
 stackit beta key-pair [flags]
@@ -29,9 +29,9 @@ stackit beta key-pair [flags]
 ### SEE ALSO
 
 * [stackit beta](./stackit_beta.md)	 - Contains beta STACKIT CLI commands
-* [stackit beta key-pair create](./stackit_beta_key-pair_create.md)	 - Create a keypair
-* [stackit beta key-pair delete](./stackit_beta_key-pair_delete.md)	 - Delete a keypair
-* [stackit beta key-pair describe](./stackit_beta_key-pair_describe.md)	 - Describe a keypair
-* [stackit beta key-pair list](./stackit_beta_key-pair_list.md)	 - Lists all SSH Keypairs
-* [stackit beta key-pair update](./stackit_beta_key-pair_update.md)	 - Update key pair
+* [stackit beta key-pair create](./stackit_beta_key-pair_create.md)	 - Create a Key Pair
+* [stackit beta key-pair delete](./stackit_beta_key-pair_delete.md)	 - Delete a Key Pair
+* [stackit beta key-pair describe](./stackit_beta_key-pair_describe.md)	 - Describe a Key Pair
+* [stackit beta key-pair list](./stackit_beta_key-pair_list.md)	 - Lists all Key Pairs
+* [stackit beta key-pair update](./stackit_beta_key-pair_update.md)	 - Update Key Pair
 

docs/stackit_beta_key-pair_create.md

@@ -1,10 +1,10 @@
 ## stackit beta key-pair create
 
-Create a keypair
+Create a Key Pair
 
 ### Synopsis
 
-Create a keypair.
+Create a Key Pair.
 
 ```
 stackit beta key-pair create [flags]
@@ -13,26 +13,26 @@ stackit beta key-pair create [flags]
 ### Examples
 
 ```
-  Create a new key-pair with public-key "ssh-rsa xxx"
-  $ stackit beta key-pair create --public-key ssh-rsa xxx
+  Create a new Key Pair with public-key "ssh-rsa xxx"
+  $ stackit beta key-pair create --public-key `ssh-rsa xxx`
 
-  Create a new key-pair with public-key from file "/Users/username/.ssh/id_rsa.pub"
-  $ stackit beta key-pair create --public-key @/Users/username/.ssh/id_rsa.pub
+  Create a new Key Pair with public-key from file "/Users/username/.ssh/id_rsa.pub"
+  $ stackit beta key-pair create --public-key `@/Users/username/.ssh/id_rsa.pub`
 
-  Create a new key-pair with name "KEYPAIR_NAME" and public-key "ssh-rsa yyy"
-  $ stackit beta key-pair create --name KEYPAIR_NAME --public-key ssh-rsa yyy
+  Create a new Key Pair with name "KEY_PAIR_NAME" and public-key "ssh-rsa yyy"
+  $ stackit beta key-pair create --name KEY_PAIR_NAME --public-key `ssh-rsa yyy`
 
-  Create a new key-pair with public-key "ssh-rsa xxx" and labels "key=value,key1=value1"
-  $ stackit beta key-pair create --public-key ssh-rsa xxx --labels key=value,key1=value1
+  Create a new Key Pair with public-key "ssh-rsa xxx" and labels "key=value,key1=value1"
+  $ stackit beta key-pair create --public-key `ssh-rsa xxx` --labels key=value,key1=value1
 ```
 
 ### Options
 
 ```
   -h, --help                    Help for "stackit beta key-pair create"
-      --labels stringToString   Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default [])
-      --name string             Name of the key which will be created
-      --public-key string       Public key which should be add (format: ssh-rsa|sha-ed25519)
+      --labels stringToString   Labels are key-value string pairs which can be attached to a Key Pair. E.g. '--labels key1=value1,key2=value2,...' (default [])
+      --name string             Key Pair name
+      --public-key string       Public key to be imported (format: ssh-rsa|ssh-ed25519)
 ```
 
 ### Options inherited from parent commands
@@ -47,5 +47,5 @@ stackit beta key-pair create [flags]
 
 ### SEE ALSO
 
-* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for Keypairs
+* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for SSH Key Pairs
 

docs/stackit_beta_key-pair_delete.md

@@ -1,10 +1,10 @@
 ## stackit beta key-pair delete
 
-Delete a keypair
+Delete a Key Pair
 
 ### Synopsis
 
-Delete a keypair.
+Delete a Key Pair.
 
 ```
 stackit beta key-pair delete [flags]
@@ -13,8 +13,8 @@ stackit beta key-pair delete [flags]
 ### Examples
 
 ```
-  Delete keypair with name "XXX"
-  $ stackit beta keypair delete XXX
+  Delete Key Pair with name "KEY_PAIR_NAME"
+  $ stackit beta key-pair delete KEY_PAIR_NAME
 ```
 
 ### Options
@@ -35,5 +35,5 @@ stackit beta key-pair delete [flags]
 
 ### SEE ALSO
 
-* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for Keypairs
+* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for SSH Key Pairs
 

docs/stackit_beta_key-pair_describe.md

@@ -1,10 +1,10 @@
 ## stackit beta key-pair describe
 
-Describe a keypair
+Describe a Key Pair
 
 ### Synopsis
 
-Describe a keypair.
+Describe a Key Pair.
 
 ```
 stackit beta key-pair describe [flags]
@@ -13,11 +13,11 @@ stackit beta key-pair describe [flags]
 ### Examples
 
 ```
-  Get details about a keypair named "KEYPAIR_NAME"
-  $ stackit beta keypair describe KEYPAIR_NAME
+  Get details about a Key Pair with name "KEY_PAIR_NAME"
+  $ stackit beta key-pair describe KEY_PAIR_NAME
 
-  Get only the SSH public key of a keypair with the name "KEYPAIR_NAME"
-  $ stackit beta keypair describe KEYPAIR_NAME --public-key
+  Get only the SSH public key of a Key Pair with name "KEY_PAIR_NAME"
+  $ stackit beta key-pair describe KEY_PAIR_NAME --public-key
 ```
 
 ### Options
@@ -39,5 +39,5 @@ stackit beta key-pair describe [flags]
 
 ### SEE ALSO
 
-* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for Keypairs
+* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for SSH Key Pairs
 

docs/stackit_beta_key-pair_list.md

@@ -1,10 +1,10 @@
 ## stackit beta key-pair list
 
-Lists all SSH Keypairs
+Lists all Key Pairs
 
 ### Synopsis
 
-Lists all SSH Keypairs.
+Lists all Key Pairs.
 
 ```
 stackit beta key-pair list [flags]
@@ -13,16 +13,16 @@ stackit beta key-pair list [flags]
 ### Examples
 
 ```
-  Lists all ssh keypairs
+  Lists all Key Pairs
   $ stackit beta key-pair list
 
-  Lists all ssh keypairs which contains the label xxx
+  Lists all Key Pairs which contains the label xxx
   $ stackit beta key-pair list --label-selector xxx
 
-  Lists all ssh keypairs in JSON format
+  Lists all Key Pairs in JSON format
   $ stackit beta key-pair list --output-format json
 
-  Lists up to 10 ssh keypairs
+  Lists up to 10 Key Pairs
   $ stackit beta key-pair list --limit 10
 ```
 
@@ -31,7 +31,7 @@ stackit beta key-pair list [flags]
 ```
   -h, --help                    Help for "stackit beta key-pair list"
       --label-selector string   Filter by label
-      --limit int               Number of SSH keypairs to list
+      --limit int               Number of Key Pairs to list
 ```
 
 ### Options inherited from parent commands
@@ -46,5 +46,5 @@ stackit beta key-pair list [flags]
 
 ### SEE ALSO
 
-* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for Keypairs
+* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for SSH Key Pairs
 

docs/stackit_beta_key-pair_update.md

@@ -1,10 +1,10 @@
 ## stackit beta key-pair update
 
-Update key pair
+Update Key Pair
 
 ### Synopsis
 
-Update key pair.
+Update Key Pair.
 
 ```
 stackit beta key-pair update [flags]
@@ -13,8 +13,8 @@ stackit beta key-pair update [flags]
 ### Examples
 
 ```
-  Update the labels of a keypair KEYPAIR_NAME with "key=value,key1=value1"
-  $ stackit beta key-pair update --labels key=value,key1=value1
+  Update the labels of a Key Pair KEY_PAIR_NAME with "key=value,key1=value1"
+  $ stackit beta key-pair update KEY_PAIR_NAME --labels key=value,key1=value1
 ```
 
 ### Options
@@ -36,5 +36,5 @@ stackit beta key-pair update [flags]
 
 ### SEE ALSO
 
-* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for Keypairs
+* [stackit beta key-pair](./stackit_beta_key-pair.md)	 - Provides functionality for SSH Key Pairs
 

internal/cmd/beta/key-pair/create/create.go

@@ -33,25 +33,25 @@ type inputModel struct {
 func NewCmd(p *print.Printer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "create",
-		Short: "Create a keypair",
-		Long:  "Create a keypair.",
+		Short: "Create a Key Pair",
+		Long:  "Create a Key Pair.",
 		Args:  cobra.NoArgs,
 		Example: examples.Build(
 			examples.NewExample(
-				`Create a new key-pair with public-key "ssh-rsa xxx"`,
-				"$ stackit beta key-pair create --public-key ssh-rsa xxx",
+				`Create a new Key Pair with public-key "ssh-rsa xxx"`,
+				"$ stackit beta key-pair create --public-key `ssh-rsa xxx`",
 			),
 			examples.NewExample(
-				`Create a new key-pair with public-key from file "/Users/username/.ssh/id_rsa.pub"`,
-				"$ stackit beta key-pair create --public-key @/Users/username/.ssh/id_rsa.pub",
+				`Create a new Key Pair with public-key from file "/Users/username/.ssh/id_rsa.pub"`,
+				"$ stackit beta key-pair create --public-key `@/Users/username/.ssh/id_rsa.pub`",
 			),
 			examples.NewExample(
-				`Create a new key-pair with name "KEYPAIR_NAME" and public-key "ssh-rsa yyy"`,
-				"$ stackit beta key-pair create --name KEYPAIR_NAME --public-key ssh-rsa yyy",
+				`Create a new Key Pair with name "KEY_PAIR_NAME" and public-key "ssh-rsa yyy"`,
+				"$ stackit beta key-pair create --name KEY_PAIR_NAME --public-key `ssh-rsa yyy`",
 			),
 			examples.NewExample(
-				`Create a new key-pair with public-key "ssh-rsa xxx" and labels "key=value,key1=value1"`,
-				"$ stackit beta key-pair create --public-key ssh-rsa xxx --labels key=value,key1=value1",
+				`Create a new Key Pair with public-key "ssh-rsa xxx" and labels "key=value,key1=value1"`,
+				"$ stackit beta key-pair create --public-key `ssh-rsa xxx` --labels key=value,key1=value1",
 			),
 		),
 		RunE: func(cmd *cobra.Command, _ []string) error {
@@ -68,7 +68,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 			}
 
 			if !model.AssumeYes {
-				prompt := "Are your sure you want to create a keypair"
+				prompt := "Are your sure you want to create a Key Pair?"
 				err = p.PromptForConfirmation(prompt)
 				if err != nil {
 					return err
@@ -79,7 +79,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 			req := buildRequest(ctx, model, apiClient)
 			resp, err := req.Execute()
 			if err != nil {
-				return fmt.Errorf("create keypair: %w", err)
+				return fmt.Errorf("create Key Pair: %w", err)
 			}
 
 			return outputResult(p, model, resp)
@@ -90,9 +90,9 @@ func NewCmd(p *print.Printer) *cobra.Command {
 }
 
 func configureFlags(cmd *cobra.Command) {
-	cmd.Flags().String(nameFlag, "", "Name of the key which will be created")
-	cmd.Flags().Var(flags.ReadFromFileFlag(), publicKeyFlag, "Public key which should be add (format: ssh-rsa|sha-ed25519)")
-	cmd.Flags().StringToString(labelFlag, nil, "Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...'")
+	cmd.Flags().String(nameFlag, "", "Key Pair name")
+	cmd.Flags().Var(flags.ReadFromFileFlag(), publicKeyFlag, "Public key to be imported (format: ssh-rsa|ssh-ed25519)")
+	cmd.Flags().StringToString(labelFlag, nil, "Labels are key-value string pairs which can be attached to a Key Pair. E.g. '--labels key1=value1,key2=value2,...'")
 
 	err := cmd.MarkFlagRequired(publicKeyFlag)
 	cobra.CheckErr(err)
@@ -146,17 +146,17 @@ func outputResult(p *print.Printer, model *inputModel, item *iaas.Keypair) error
 	case print.JSONOutputFormat:
 		details, err := json.MarshalIndent(item, "", "  ")
 		if err != nil {
-			return fmt.Errorf("marshal keypair: %w", err)
+			return fmt.Errorf("marshal Key Pair: %w", err)
 		}
 		p.Outputln(string(details))
 	case print.YAMLOutputFormat:
 		details, err := yaml.MarshalWithOptions(item, yaml.IndentSequence(true))
 		if err != nil {
-			return fmt.Errorf("marshal keypair: %w", err)
+			return fmt.Errorf("marshal Key Pair: %w", err)
 		}
 		p.Outputln(string(details))
 	default:
-		p.Outputf("Created keypair %q.\nKeypair Fingerprint: %q\n", *item.Name, *item.Fingerprint)
+		p.Outputf("Created Key Pair %q.\nKey Pair Fingerprint: %q\n", *item.Name, *item.Fingerprint)
 	}
 	return nil
 }

internal/cmd/beta/key-pair/create/create_test.go

@@ -20,13 +20,13 @@ var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo")
 var testClient = &iaas.APIClient{}
 
 var testPublicKey = "ssh-rsa <key>"
-var testKeypairName = "foobar_key"
+var testKeyPairName = "foobar_key"
 
 func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string {
 	flagValues := map[string]string{
 		publicKeyFlag: testPublicKey,
 		labelFlag:     "foo=bar",
-		nameFlag:      testKeypairName,
+		nameFlag:      testKeyPairName,
 	}
 	for _, mod := range mods {
 		mod(flagValues)
@@ -43,7 +43,7 @@ func fixtureInputModel(mods ...func(model *inputModel)) *inputModel {
 			"foo": "bar",
 		}),
 		PublicKey: utils.Ptr(testPublicKey),
-		Name:      utils.Ptr(testKeypairName),
+		Name:      utils.Ptr(testKeyPairName),
 	}
 	for _, mod := range mods {
 		mod(model)
@@ -66,7 +66,7 @@ func fixturePayload(mods ...func(payload *iaas.CreateKeyPairPayload)) iaas.Creat
 			"foo": "bar",
 		}),
 		PublicKey: utils.Ptr(testPublicKey),
-		Name:      utils.Ptr(testKeypairName),
+		Name:      utils.Ptr(testKeyPairName),
 	}
 	for _, mod := range mods {
 		mod(&payload)
@@ -102,11 +102,11 @@ func TestParseInput(t *testing.T) {
 		{
 			description: "read public key from file",
 			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
-				flagValues[publicKeyFlag] = "@./create_test.go"
+				flagValues[publicKeyFlag] = "@/template/id_ed25519.pub"
 			}),
 			isValid: true,
 			expectedModel: fixtureInputModel(func(model *inputModel) {
-				file, err := os.ReadFile("./create_test.go")
+				file, err := os.ReadFile("./template/id_ed25519.pub")
 				if err != nil {
 					t.Fatal("could not create expected Model", err)
 				}

internal/cmd/beta/key-pair/create/template/id_ed25519.pub

@@ -0,0 +1 @@
+ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG1ogKtJ5SElBm3mxhFhdvXxXiz+FxYoOvcdWSW2/ZI