audit: docs

audit/formatter.go

@@ -9,6 +9,8 @@ import (
 // Formatter is an interface that is responsible for formating a
 // request/response into some format. Formatters write their output
 // to an io.Writer.
+//
+// It is recommended that you pass data through Hash prior to formatting it.
 type Formatter interface {
 	FormatRequest(io.Writer, *logical.Auth, *logical.Request) error
 	FormatResponse(io.Writer, *logical.Auth, *logical.Request, *logical.Response, error) error

audit/hashstructure_test.go

@@ -41,6 +41,10 @@ func TestHash(t *testing.T) {
 				},
 			},
 		},
+		{
+			"foo",
+			"foo",
+		},
 	}
 
 	for _, tc := range cases {