MINOR: Improve docs for principal format #1143
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sirianni
approved these changes
Jan 12, 2022
internal/pkg/errors/error_message.go
Outdated
| @@ -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`." | |||
There was a problem hiding this comment.
Are there other principal types worth including in this example instead of User twice?
brianstrauch
approved these changes
Jan 12, 2022
test/fixtures/output/iam/rbac/role-binding/list-principal-format-error-onprem.golden
Outdated
Show resolved
Hide resolved
Co-authored-by: Brian Strauch <bstrauch@confluent.io>
…at-error-onprem.golden Co-authored-by: Brian Strauch <bstrauch@confluent.io>
test/fixtures/output/iam/rbac/role-binding/list-principal-format-error-onprem.golden
Outdated
Show resolved
Hide resolved
…at-error-onprem.golden Co-authored-by: Brian Strauch <bstrauch@confluent.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.