fix: use yaml.v3 and address conflicts

Author: vivshankar

go.mod

@@ -3,14 +3,16 @@ module github.com/ibm-verify/verifyctl
 go 1.23.0
 
 require (
-	github.com/ibm-verify/verify-sdk-go v0.0.5
+	github.com/ibm-verify/verify-sdk-go v0.0.7
 	github.com/oapi-codegen/oapi-codegen/v2 v2.4.1
 	github.com/oapi-codegen/runtime v1.1.1
 	github.com/spf13/cobra v1.8.1
 	golang.org/x/oauth2 v0.26.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1
 )
 
+require gopkg.in/yaml.v2 v2.4.0 // indirect
+
 require (
 	github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect
 	github.com/dprotaso/go-yit v0.0.0-20220510233725-9ba8df137936 // indirect
@@ -28,7 +30,6 @@ require (
 	golang.org/x/mod v0.17.0 // indirect
 	golang.org/x/text v0.24.0 // indirect
 	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 )
 
 require (

go.sum

@@ -46,8 +46,8 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
-github.com/ibm-verify/verify-sdk-go v0.0.5 h1:+D1VdqZ9akfu0PZl4zBl1Sm5fNzXpmsadX+nQKOhkgA=
-github.com/ibm-verify/verify-sdk-go v0.0.5/go.mod h1:Vc1sOwMPmXCwHox3hLWQgt4DFaeXPpMyEd+IHZoAOgg=
+github.com/ibm-verify/verify-sdk-go v0.0.7 h1:nSaoOcm3VWmzDv6vcRlmTweNg2r3uA2oHrRV0KVgFpE=
+github.com/ibm-verify/verify-sdk-go v0.0.7/go.mod h1:Vc1sOwMPmXCwHox3hLWQgt4DFaeXPpMyEd+IHZoAOgg=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/invopop/yaml v0.3.1 h1:f0+ZpmhfBSS4MhG+4HYseMdJhoeeopbSKbq5Rpeelso=

pkg/cmd/create/api_client.go

@@ -5,11 +5,12 @@ import (
 	"io"
 	"os"
 
+	"github.com/ibm-verify/verify-sdk-go/pkg/config/security"
 	"github.com/ibm-verify/verifyctl/pkg/cmd/resource"
 	"github.com/ibm-verify/verifyctl/pkg/config"
-	"github.com/ibm-verify/verifyctl/pkg/module/security"
 	cmdutil "github.com/ibm-verify/verifyctl/pkg/util/cmd"
 	"github.com/ibm-verify/verifyctl/pkg/util/templates"
+	"gopkg.in/yaml.v3"
 
 	contextx "github.com/ibm-verify/verify-sdk-go/pkg/core/context"
 	errorsx "github.com/ibm-verify/verify-sdk-go/pkg/core/errors"
@@ -43,9 +44,13 @@ var (
 	apiClientExamples = templates.Examples(cmdutil.TranslateExamples(apiClientMessagePrefix, `
         # Create an empty API client resource.
         verifyctl create apiclient --boilerplate
+
+		
+		# Create an API client using a YAML file.
+        verifyctl create -f=./apiclient.yaml
  
         # Create an API client using a JSON file.
-        verifyctl create apiclient -f=./apiclient.json`))
+        verifyctl create -f=./apiclient.json`))
 )
 
 type apiClientOptions struct {
@@ -105,27 +110,26 @@ func (o *apiClientOptions) Run(cmd *cobra.Command, args []string) error {
 		cmdutil.WriteString(cmd, entitlementsMessage+"  "+apiClientEntitlements)
 		return nil
 	}
-
 	if o.boilerplate {
 		resourceObj := &resource.ResourceObject{
 			Kind:       resource.ResourceTypePrefix + "ApiClient",
 			APIVersion: "1.0",
-			Data:       &security.Client{},
+			Data:       security.APIClientExample(),
 		}
 
 		cmdutil.WriteAsYAML(cmd, resourceObj, cmd.OutOrStdout())
 		return nil
 	}
 
-	auth, err := o.config.GetCurrentAuth()
+	_, err := o.config.GetCurrentAuth()
 	if err != nil {
 		return err
 	}
 
-	return o.createAPIClient(cmd, auth)
+	return o.createAPIClient(cmd)
 }
 
-func (o *apiClientOptions) createAPIClient(cmd *cobra.Command, auth *config.AuthConfig) error {
+func (o *apiClientOptions) createAPIClient(cmd *cobra.Command) error {
 	ctx := cmd.Context()
 	vc := contextx.GetVerifyContext(ctx)
 
@@ -135,15 +139,15 @@ func (o *apiClientOptions) createAPIClient(cmd *cobra.Command, auth *config.Auth
 		return err
 	}
 
-	return o.createAPIClientWithData(cmd, auth, b)
+	return o.createAPIClientWithData(cmd, b)
 }
 
-func (o *apiClientOptions) createAPIClientWithData(cmd *cobra.Command, auth *config.AuthConfig, data []byte) error {
+func (o *apiClientOptions) createAPIClientWithData(cmd *cobra.Command, data []byte) error {
 	ctx := cmd.Context()
 	vc := contextx.GetVerifyContext(ctx)
 
 	apiclient := &security.APIClientConfig{}
-	if err := json.Unmarshal(data, &apiclient); err != nil {
+	if err := yaml.Unmarshal(data, &apiclient); err != nil {
 		vc.Logger.Errorf("unable to unmarshal API client; err=%v", err)
 		return err
 	}
@@ -156,7 +160,7 @@ func (o *apiClientOptions) createAPIClientWithData(cmd *cobra.Command, auth *con
 	}
 
 	client := security.NewAPIClient()
-	resourceURI, err := client.CreateAPIClient(ctx, auth, apiclient)
+	resourceURI, err := client.CreateAPIClient(ctx, apiclient)
 	if err != nil {
 		vc.Logger.Errorf("failed to create API client; err=%v", err)
 		return err
@@ -166,11 +170,10 @@ func (o *apiClientOptions) createAPIClientWithData(cmd *cobra.Command, auth *con
 	return nil
 }
 
-func (o *apiClientOptions) createAPIClientFromDataMap(cmd *cobra.Command, auth *config.AuthConfig, data map[string]interface{}) error {
+func (o *apiClientOptions) createAPIClientFromDataMap(cmd *cobra.Command, data map[string]interface{}) error {
 	ctx := cmd.Context()
 	vc := contextx.GetVerifyContext(ctx)
 
-	// Convert map data to JSON
 	apiclient := &security.APIClientConfig{}
 	b, err := json.Marshal(data)
 	if err != nil {
@@ -183,23 +186,20 @@ func (o *apiClientOptions) createAPIClientFromDataMap(cmd *cobra.Command, auth *
 		return err
 	}
 
-	// Validate required fields
 	if apiclient.ClientName == "" {
 		return errorsx.G11NError("clientName is required")
 	}
 	if len(apiclient.Entitlements) == 0 {
 		return errorsx.G11NError("entitlements list is required")
 	}
 
-	// Create API client
 	client := security.NewAPIClient()
-	resourceURI, err := client.CreateAPIClient(ctx, auth, apiclient)
+	resourceURI, err := client.CreateAPIClient(ctx, apiclient)
 	if err != nil {
 		vc.Logger.Errorf("failed to create API client; err=%v", err)
 		return err
 	}
 
-	// Directly return the created resource URI
 	cmdutil.WriteString(cmd, "Resource created: "+resourceURI)
 	return nil
 }

pkg/cmd/create/create.go

@@ -153,7 +153,7 @@ func (o *options) Run(cmd *cobra.Command, args []string) error {
 
 	case resource.ResourceTypePrefix + "APIClient":
 		options := &apiClientOptions{}
-		err = options.createAPIClientFromDataMap(cmd, auth, resourceObject.Data.(map[string]interface{}))
+		err = options.createAPIClientFromDataMap(cmd, resourceObject.Data.(map[string]interface{}))
 	}
 
 	return err

pkg/cmd/delete/api_client.go

@@ -3,14 +3,13 @@ package delete
 import (
 	"io"
 
+	"github.com/ibm-verify/verify-sdk-go/pkg/config/security"
 	"github.com/ibm-verify/verify-sdk-go/pkg/i18n"
 	"github.com/ibm-verify/verifyctl/pkg/config"
-	"github.com/ibm-verify/verifyctl/pkg/module/security"
 	cmdutil "github.com/ibm-verify/verifyctl/pkg/util/cmd"
 	"github.com/ibm-verify/verifyctl/pkg/util/templates"
 	"github.com/spf13/cobra"
 
-	contextx "github.com/ibm-verify/verify-sdk-go/pkg/core/context"
 	errorsx "github.com/ibm-verify/verify-sdk-go/pkg/core/errors"
 )
 
@@ -37,14 +36,13 @@ You can identify the entitlement required by running:
 		verifyctl delete apiclient --clientName="clientName",
 
 		# Delete an API client by ID
-		verifyctl delete apiclient --clientId="12345"`,
+		verifyctl delete apiclient --clientID="12345"`,
 	))
 )
 
 type apiclientsOptions struct {
 	options
-	id string
-
+	id     string
 	config *config.CLIConfig
 }
 
@@ -77,8 +75,7 @@ func NewAPIClientCommand(config *config.CLIConfig, streams io.ReadWriter) *cobra
 
 func (o *apiclientsOptions) AddFlags(cmd *cobra.Command) {
 	o.addCommonFlags(cmd)
-	cmd.Flags().StringVar(&o.name, "clientName", o.name, i18n.Translate("clientName to be deleted"))
-	cmd.Flags().StringVar(&o.id, "clientId", o.id, i18n.Translate("clientId to be deleted"))
+	cmd.Flags().StringVar(&o.id, "clientID", o.id, i18n.Translate("clientID to be deleted"))
 }
 
 func (o *apiclientsOptions) Complete(cmd *cobra.Command, args []string) error {
@@ -91,8 +88,8 @@ func (o *apiclientsOptions) Validate(cmd *cobra.Command, args []string) error {
 	}
 
 	calledAs := cmd.CalledAs()
-	if calledAs == "apiclient" && o.name == "" && o.id == "" {
-		return errorsx.G11NError("either 'clientName' or 'clientId' flag is required")
+	if calledAs == "apiclient" && o.id == "" {
+		return errorsx.G11NError("'clientId' flag is required")
 	}
 	return nil
 }
@@ -103,47 +100,33 @@ func (o *apiclientsOptions) Run(cmd *cobra.Command, args []string) error {
 		return nil
 	}
 
-	auth, err := o.config.SetAuthToContext(cmd.Context())
+	_, err := o.config.SetAuthToContext(cmd.Context())
 	if err != nil {
 		return err
 	}
 
-	// invoke the operation
-	if cmd.CalledAs() == "apiclient" || len(o.name) > 0 {
-		// deal with single API client
-		return o.handleSingleAPIClient(cmd, auth, args)
+	if cmd.CalledAs() == "apiclient" {
+		return o.handleSingleAPIClient(cmd, args)
 	}
 	return nil
 }
 
-func (o *apiclientsOptions) handleSingleAPIClient(cmd *cobra.Command, auth *config.AuthConfig, _ []string) error {
+func (o *apiclientsOptions) handleSingleAPIClient(cmd *cobra.Command, _ []string) error {
 	c := security.NewAPIClient()
 	var id string
 	var err error
 
 	if o.id != "" {
-		if o.name != "" {
-			contextx.GetVerifyContext(cmd.Context()).Logger.Warnf("Both clientName and clientId are provided; using clientId")
-		}
 		id = o.id
-	} else if o.name != "" {
-		id, err = c.GetAPIClientId(cmd.Context(), auth, o.name)
+		err = c.DeleteAPIClientById(cmd.Context(), id)
 		if err != nil {
 			return err
 		}
 	} else {
 		return errorsx.G11NError("either clientName or clientId must be provided")
 	}
 
-	err = c.DeleteAPIClientById(cmd.Context(), auth, id)
-	if err != nil {
-		return err
-	}
-
-	resourceIdentifier := o.name
-	if o.id != "" {
-		resourceIdentifier = o.id
-	}
-	cmdutil.WriteString(cmd, "Resource deleted: "+resourceIdentifier)
+	resourceIdentifier := o.id
+	cmdutil.WriteString(cmd, "Resource deleted with ID: "+resourceIdentifier)
 	return nil
 }

pkg/cmd/get/api_client.go

@@ -3,11 +3,11 @@ package get
 import (
 	"io"
 
+	"github.com/ibm-verify/verify-sdk-go/pkg/config/security"
 	errorsx "github.com/ibm-verify/verify-sdk-go/pkg/core/errors"
 	"github.com/ibm-verify/verify-sdk-go/pkg/i18n"
 	"github.com/ibm-verify/verifyctl/pkg/cmd/resource"
 	"github.com/ibm-verify/verifyctl/pkg/config"
-	"github.com/ibm-verify/verifyctl/pkg/module/security"
 	cmdutil "github.com/ibm-verify/verifyctl/pkg/util/cmd"
 	"github.com/ibm-verify/verifyctl/pkg/util/templates"
 	"github.com/spf13/cobra"
@@ -33,9 +33,11 @@ You can identify the entitlement required by running:
 
 	apiclientsExamples = templates.Examples(cmdutil.TranslateExamples(messagePrefix, `
 		# Get an apiclient and print the output in yaml
-		verifyctl get apiclient -o=yaml --name=testApiclient
+		verifyctl get apiclient -o=yaml --clientName=testApiclient
+		verifyctl get apiclient -o=yaml --clientID=12345
 
-		# Get 10 apiclients based on a given search criteria and sort it in the ascending order by name.
+
+		# Get 2 apiclients based on a given search criteria and sort it in the ascending order by name.
 		verifyctl get apiclients --count=2 --sort=apiclientName -o=yaml`))
 )
 
@@ -76,6 +78,7 @@ func NewAPIClientsCommand(config *config.CLIConfig, streams io.ReadWriter) *cobr
 func (o *apiclientsOptions) AddFlags(cmd *cobra.Command) {
 	o.addCommonFlags(cmd, apiclientResourceName)
 	cmd.Flags().StringVar(&o.name, "clientName", o.name, i18n.Translate("clientName to get details"))
+	cmd.Flags().StringVar(&o.id, "clientID", o.id, i18n.Translate("clientID to get details"))
 	o.addSortFlags(cmd, apiclientResourceName)
 	o.addCountFlags(cmd, apiclientResourceName)
 }
@@ -90,8 +93,11 @@ func (o *apiclientsOptions) Validate(cmd *cobra.Command, args []string) error {
 	}
 
 	calledAs := cmd.CalledAs()
-	if calledAs == "apiclient" && o.name == "" {
-		return errorsx.G11NError("'clientName' flag is required.")
+	if calledAs == "apiclient" && o.name == "" && o.id == "" {
+		return errorsx.G11NError("either 'clientName' or 'clientID' flag is required.")
+	}
+	if o.name != "" && o.id != "" {
+		return errorsx.G11NError("only one of 'clientName' or 'clientID' can be provided")
 	}
 	return nil
 }
@@ -102,22 +108,30 @@ func (o *apiclientsOptions) Run(cmd *cobra.Command, args []string) error {
 		return nil
 	}
 
-	auth, err := o.config.SetAuthToContext(cmd.Context())
+	_, err := o.config.SetAuthToContext(cmd.Context())
 	if err != nil {
 		return err
 	}
 
-	if cmd.CalledAs() == "apiclient" || len(o.name) > 0 {
-		return o.handleSingleAPIClient(cmd, auth, args)
+	if cmd.CalledAs() == "apiclient" || len(o.name) > 0 || len(o.id) > 0 {
+		return o.handleSingleAPIClient(cmd, args)
 	}
 
-	return o.handleAPIClientList(cmd, auth, args)
+	return o.handleAPIClientList(cmd, args)
 }
 
-func (o *apiclientsOptions) handleSingleAPIClient(cmd *cobra.Command, auth *config.AuthConfig, _ []string) error {
+func (o *apiclientsOptions) handleSingleAPIClient(cmd *cobra.Command, _ []string) error {
 
 	c := security.NewAPIClient()
-	apic, uri, err := c.GetAPIClient(cmd.Context(), auth, o.name)
+	var apic *security.APIClientConfig
+	var uri string
+	var err error
+
+	if o.id != "" {
+		apic, uri, err = c.GetAPIClientByID(cmd.Context(), o.id)
+	} else {
+		apic, uri, err = c.GetAPIClientByName(cmd.Context(), o.name)
+	}
 	if err != nil {
 		return err
 	}
@@ -147,10 +161,10 @@ func (o *apiclientsOptions) handleSingleAPIClient(cmd *cobra.Command, auth *conf
 	return nil
 }
 
-func (o *apiclientsOptions) handleAPIClientList(cmd *cobra.Command, auth *config.AuthConfig, _ []string) error {
+func (o *apiclientsOptions) handleAPIClientList(cmd *cobra.Command, _ []string) error {
 
 	c := security.NewAPIClient()
-	apiclis, uri, err := c.GetAPIClients(cmd.Context(), auth, o.search, o.sort, o.page, o.limit)
+	apiclis, uri, err := c.GetAPIClients(cmd.Context(), o.search, o.sort, o.page, o.limit)
 	if err != nil {
 		return err
 	}