chore: generate examples for apigeecli

Author: srinandan

README.md

@@ -192,6 +192,7 @@ The following environment variables may be set to control the behavior of `apige
 * `APIGEECLI_DRYRUN=true` does not execute Apigee control plane APIs
 
 ## Version 2.x.x Breaking Changes
+
 The following command line flags have changed to follow a more consistent naming convention. The previous flag name and shorthand character are left of `==>` and the new flag name and shorthand are to the right.
 For example:  `"flagName", "f" ==> "flag-name", "f"`
 
@@ -232,7 +233,9 @@ Some changes merely drop the shorthand character.
 ```
 
 ## Version 2.0.0 New Changes
+
 A new flag was introduced to control output from apigeecli, that may impact your output if used in an automation pipeline.
+
 ```
 --no-warnings      Disable printing warnings to stderr
 ```
@@ -434,26 +437,9 @@ x-google-jwt-locations:
 
 query parameters are ignored. By default, if no location is specified, the JWT location is the `Authorization` header and value_prefix is `Bearer <token>`
 
-## How do I import entities using apigeecli?
-
-The table below illustrates how you can import different entities into Apigee. It refers to the [samples](./samples/) directory.
-
-
-| Operations | Import command |
-|---|---|
-| apicategories | `apigeecli apicategories import -o $org -t $token -f samples/apicategories.json -s $siteId` |
-| apis | `apigeecli apis import -f samples/apis -o $org -t $token` |
-| appgroups | `apigeecli appgroups import -f samples/appgroups.json -o $org -t $token` |
-| datacollectors | `apigeecli datacollectors import -f samples/datacollectors.json -o $org -t $token` |
-| developers | `apigeecli developers import -f samples/developers.json -o $org -t $token` |
-| kvms | `apigeecli kvms import -f samples/kvms -o $org -t $token` (Rename the files under samples/kvms to match your Apigee setup)  |
-| products | `apigeecli products import -f samples/apiproduct-legacy.json -o $org -t $token`  `apigeecli products import -f samples/apiproduct-gqlgroup.json -o $org -t $token`  `apigeecli products import -f samples/apiproduct-op-group.json -o $org -t $token` |
-| sharedflows | `apigeecli sharedflows import -f samples/sharedflows -o $org -t $token` |
-| targetservers | `apigeecli targetservers import -f samples/targetservers.json -o $org -t $token -e $env` |
-| keystores | `apigeecli keystores import -f samples/keystores.json -o $org -t $token -e $env` |
-| references | `apigeecli references import -f samples/references.json -o $org -t $token -e $env` |
-| apps | `apigeecli apps import -f samples/references.json -d samples/developers.json -o $org -t $token` (better used when the developers and apps are exported using the export) |
-| apidocs | `apigeecli apidocs import -f samples/apidocs -o $org -t $token -s $siteId` (Rename the files under samples/apidocs to match your Apigee setup for siteId) |
+## Samples
+
+Please see [here](./samples/README.md)
 
 ## How do I verify the binary?
 

docs/docs.go

@@ -15,15 +15,42 @@
 package main
 
 import (
+	"io"
 	"log"
 	"os"
 	"path/filepath"
 
-	cmd "internal/cmd"
+	apiclient "internal/apiclient"
+	"internal/cmd"
+	apicategories "internal/cmd/apicategories"
+	products "internal/cmd/products"
 
 	"github.com/spf13/cobra/doc"
 )
 
+var samples = `# apigeecli Samples
+Set up apigeecli with preferences: apigeecli prefs set -o $org -t $(gcloud auth print-access-token)
+
+| Operations | Command |
+|---|---|
+| apicategories | ` + apicategories.GetExample(0) + `|
+| apis | apigeecli apis import -f samples/apis -o $org -t $token |
+| appgroups | apigeecli appgroups import -f samples/appgroups.json -o $org -t $token |
+| datacollectors | apigeecli datacollectors import -f samples/datacollectors.json -o $org -t $token |
+| developers | apigeecli developers import -f samples/developers.json -o $org -t $token |
+| kvms | apigeecli kvms import -f samples/kvms -o $org -t $token (Rename the files under samples/kvms to match your Apigee setup)  |
+| products | ` + products.GetExample(2) + ` |
+| products | ` + products.GetExample(3) + ` |
+| products | ` + products.GetExample(4) + ` |
+| products | ` + products.GetExample(0) + ` |
+| products | ` + products.GetExample(1) + ` |
+| sharedflows | apigeecli sharedflows import -f samples/sharedflows -o $org -t $token |
+| targetservers | apigeecli targetservers import -f samples/targetservers.json -o $org -t $token -e $env |
+| keystores | apigeecli keystores import -f samples/keystores.json -o $org -t $token -e $env |
+| references | apigeecli references import -f samples/references.json -o $org -t $token -e $env |
+| apps | apigeecli apps import -f samples/references.json -d samples/developers.json -o $org -t $token (better used when the developers and apps are exported using the export) |
+| apidocs | apigeecli apidocs import -f samples/apidocs -o $org -t $token -s $siteId (Rename the files under samples/apidocs to match your Apigee setup for siteId) |`
+
 func main() {
 	var err error
 	var docFiles []string
@@ -41,4 +68,21 @@ func main() {
 	if err = doc.GenMarkdownTree(cmd.RootCmd, "./docs"); err != nil {
 		log.Fatal(err)
 	}
+
+	_ = apiclient.WriteByteArrayToFile("./samples/README.md", false, []byte(samples))
+}
+
+func WriteFile() (byteValue []byte, err error) {
+	userFile, err := os.Open("./samples/README.md")
+	if err != nil {
+		return nil, err
+	}
+
+	defer userFile.Close()
+
+	byteValue, err = io.ReadAll(userFile)
+	if err != nil {
+		return nil, err
+	}
+	return byteValue, err
 }

internal/cmd/apicategories/apicategories.go

@@ -27,6 +27,8 @@ var Cmd = &cobra.Command{
 
 var org, siteid, id, region string
 
+var examples = []string{"apigeecli apicategories import --file samples/apicategories.json --siteid $siteId"}
+
 func init() {
 	Cmd.PersistentFlags().StringVarP(&org, "org", "o",
 		"", "Apigee organization name")
@@ -47,3 +49,7 @@ func init() {
 	_ = Cmd.MarkFlagRequired("org")
 	_ = Cmd.MarkFlagRequired("siteid")
 }
+
+func GetExample(i int) string {
+	return examples[i]
+}

internal/cmd/apicategories/import.go

@@ -33,6 +33,8 @@ var ImpCmd = &cobra.Command{
 		apiclient.SetRegion(region)
 		return apiclient.SetApigeeOrg(org)
 	},
+	Example: `Import an existing apicategories from a file:
+	` + GetExample(0),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		if siteid == "" {
 			return fmt.Errorf("siteid is a mandatory parameter")

internal/cmd/products/crtprod.go

@@ -71,24 +71,10 @@ var CreateCmd = &cobra.Command{
 		return err
 	},
 	Example: `Create an API product, using externally defined operations, with auto approval and access=public:
-  apigeecli products create --name "$product_name" \
-		--display-name "$product_name" \
-		--opgrp "$ops_file" \
-		--envs "$env" \
-		--approval auto \
-		--attrs access=public \
-		--token $TOKEN
+` + GetExample(0) + `
 
 Create an API product, using externally defined operations, with auto approval and access=public, and a quota of 100/minute:
-  apigeecli products create --name "$product_name" \
-		--display-name "$product_name" \
-		--opgrp "$ops_file" \
-		--envs "$env" \
-		--approval auto \
-		--attrs access=public \
-		--quota 100 --interval 1 --unit minute \
-		--token $TOKEN
-`,
+` + GetExample(1),
 }
 
 var operationGroupFile, gqlOperationGroupFile, grpcOperationGroupFile, quotaCounterScope string

internal/cmd/products/impprod.go

@@ -27,6 +27,11 @@ var ImpCmd = &cobra.Command{
 	Use:   "import",
 	Short: "Import a file containing API products",
 	Long:  "Import a file containing API products",
+	Example: `Import API Products from a file containing REST Operations
+` + GetExample(2) + `
+
+Import API Products from a file containing GraphQL Operations
+` + GetExample(3),
 	Args: func(cmd *cobra.Command, args []string) (err error) {
 		apiclient.SetRegion(region)
 		return apiclient.SetApigeeOrg(org)

internal/cmd/products/products.go

@@ -44,6 +44,22 @@ var (
 	attrs                                                               map[string]string
 )
 
+var examples = []string{`apigeecli products create --name $product_name \\
+--display-name $product_name \
+--opgrp $ops_file \
+--envs $env \
+--approval auto \
+--attrs access=public`, `apigeecli products create --name $product_name \
+--display-name $product_name \
+--opgrp $ops_file \
+--envs $env \
+--approval auto \
+--attrs access=public \
+--quota 100 --interval 1 --unit minute`,
+	`apigeecli products import -f samples/apiproduct-legacy.json`,
+	`apigeecli products import -f samples/apiproduct-gqlgroup.json`,
+	`apigeecli products import -f samples/apiproduct-op-group.json`}
+
 func init() {
 	Cmd.PersistentFlags().StringVarP(&org, "org", "o",
 		"", "Apigee organization name")
@@ -136,3 +152,7 @@ func getAttributes(attrs map[string]string) []products.Attribute {
 
 	return nil
 }
+
+func GetExample(i int) string {
+	return examples[i]
+}