fix(example): improve arg name used for tls skip verify #2385
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
|
CLA signed. |
michaeljmarshall
force-pushed
the
improve-examples
branch
from
9545835
to
06e66f9
Compare
dnwe
approved these changes
Dec 13, 2022
dnwe
changed the title
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
Two examples have inverted parameters name
verifySslinstead oftlsSkipVerify. This could lead someone to misuse the API and think they are enabling a secure setting when actually setting an insecure setting.Modifications
verifySslwithtlsSkipVerifyto match https://github.com/Shopify/sarama/blob/610514edec1825240d59b62e4d7f1aba4b1fa000/tools/kafka-console-consumer/kafka-console-consumer.go#L25Context
Technically, this is a breaking change in the variable names, but since it is an example, I think that's acceptable.