Add a deprecated helper to tokenutil and JSON output to path-help (#7006

)
hashicorp · Jun 27, 2019 · fe636fb · fe636fb
1 parent 0a58f30
commit fe636fb
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/api/help.go b/api/help.go
@@ -24,6 +24,7 @@ func (c *Client) Help(path string) (*Help, error) {
 }
 
 type Help struct {
-	Help    string   `json:"help"`
-	SeeAlso []string `json:"see_also"`
+	Help    string                 `json:"help"`
+	SeeAlso []string               `json:"see_also"`
+	OpenAPI map[string]interface{} `json:"openapi"`
 }
diff --git a/command/path_help.go b/command/path_help.go
@@ -1,6 +1,7 @@
 package command
 
 import (
+	"encoding/json"
 	"fmt"
 	"strings"
 
@@ -44,13 +45,15 @@ Usage: vault path-help [options] PATH
 
   Each secret engine produces different help output.
 
+  If -format is specified as JSON, the output will be in OpenAPI format.
+
 ` + c.Flags().Help()
 
 	return strings.TrimSpace(helpText)
 }
 
 func (c *PathHelpCommand) Flags() *FlagSets {
-	return c.flagSet(FlagSetHTTP)
+	return c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
 }
 
 func (c *PathHelpCommand) AutocompleteArgs() complete.Predictor {
@@ -97,6 +100,17 @@ func (c *PathHelpCommand) Run(args []string) int {
 		return 2
 	}
 
-	c.UI.Output(help.Help)
+	switch c.flagFormat {
+	case "json":
+		b, err := json.Marshal(help.OpenAPI)
+		if err != nil {
+			c.UI.Error(fmt.Sprintf("Error marshaling OpenAPI: %s", err))
+			return 2
+		}
+		c.UI.Output(string(b))
+	default:
+		c.UI.Output(help.Help)
+	}
+
 	return 0
 }