MINOR: Improve docs for principal format (#1143)

* MINOR: Improve docs for principal format * Update internal/pkg/errors/error_message.go Co-authored-by: Brian Strauch <bstrauch@confluent.io> * Update test/fixtures/output/iam/rbac/role-binding/list-principal-format-error-onprem.golden Co-authored-by: Brian Strauch <bstrauch@confluent.io> * Update test/fixtures/output/iam/rbac/role-binding/list-principal-format-error-onprem.golden Co-authored-by: Brian Strauch <bstrauch@confluent.io> Co-authored-by: Brian Strauch <bstrauch@confluent.io> Co-authored-by: David Hyde <DABH@users.noreply.github.com>
confluentinc · Jan 12, 2022 · 11061be · 11061be
1 parent 9d471c3
commit 11061be
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/internal/pkg/errors/error_message.go b/internal/pkg/errors/error_message.go
@@ -72,7 +72,7 @@ const (
 
 	// iam rbac role-binding commands
 	PrincipalFormatErrorMsg         = "incorrect principal format specified"
-	PrincipalFormatSuggestions      = "Principal must be specified in this format: `<Principal Type>:<Principal Name>`."
+	PrincipalFormatSuggestions      = "Principal must be specified in this format: \"<Principal Type>:<Principal Name>\".\nFor example, \"User:u-xxxxxx\" or \"User:sa-xxxxxx\"."
 	ResourceFormatErrorMsg          = "incorrect resource format specified"
 	ResourceFormatSuggestions       = "Resource must be specified in this format: `<Resource Type>:<Resource Name>`."
 	LookUpRoleErrorMsg              = "failed to lookup role \"%s\""

diff --git a/test/fixtures/output/iam/rbac/role-binding/list-principal-format-error-onprem.golden b/test/fixtures/output/iam/rbac/role-binding/list-principal-format-error-onprem.golden
@@ -1,4 +1,5 @@
 Error: incorrect principal format specified
 
 Suggestions:
-    Principal must be specified in this format: `<Principal Type>:<Principal Name>`.
+    Principal must be specified in this format: "<Principal Type>:<Principal Name>".
+    For example, "User:u-xxxxxx" or "User:sa-xxxxxx".