improvement doc of --auth-params in pulsar-client cli
#3605
Conversation
This file contains hidden or 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
merlimat
reviewed
Feb 15, 2019
| @@ -288,7 +288,7 @@ Commands | |||
| Options | |||
| |Flag|Description|Default| | |||
| |---|---|---| | |||
| |`--auth-params`|Authentication parameters, for example key1:val1,key2:val2|| | |||
| |`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{\"key1\":\"val1\",\"key2\":\"val2\"}"|| | |||
There was a problem hiding this comment.
We should also fix the same description in the JCommander help string that is shown when using the tool
merlimat
added
the
doc
|
rerun integration tests |
sijie
approved these changes
Feb 20, 2019
sijie
requested changes
Feb 20, 2019
diff.patch
Outdated
| @@ -0,0 +1,106 @@ | |||
| diff --git pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/PulsarAdminTool.java pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/PulsarAdminTool.java | |||
There was a problem hiding this comment.
@jiazhai it seems you are adding diff.patch by mistake?
sijie
approved these changes
Feb 22, 2019
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.
Motivation
User report documentation is not very clear for pulsar-client command
--auth-paramsparameter.for org.apache.pulsar.client.impl.auth.AuthenticationBasic, it is in Json format
Modifications
fix doc