Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

security_protocol argument docstring does not mention SASL_SSL or SASL_PLAINTEXT #883

Closed
gabrielmbmb opened this issue Apr 11, 2023 · 0 comments · Fixed by #884
Closed

Comments

@gabrielmbmb
Copy link
Contributor

gabrielmbmb commented Apr 11, 2023

Describe the bug

The security_protocol argument docstring in aiokafka.{AIOKafkaConsumer, AIOKafkaProducer} does not mention SASL_SSL and SASL_PLAINTEXT as possible values but they are as mentioned in the sasl_mechanism argument docstring.

security_protocol (str): Protocol used to communicate with brokers.
Valid values are: ``PLAINTEXT``, ``SSL``. Default: ``PLAINTEXT``.
Default: ``PLAINTEXT``.

security_protocol (str): Protocol used to communicate with brokers.
Valid values are: ``PLAINTEXT``, ``SSL``. Default: ``PLAINTEXT``.

aiokafka.client.AIOKafkaClient does mention all the possible values:

security_protocol (str): Protocol used to communicate with brokers.
Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
Default: PLAINTEXT.

Expected behaviour
security_protocol argument docstring mentions SASL_SSL and SASL_PLAINTEXT as possible values.

Environment (please complete the following information):

  • aiokafka version (python -c "import aiokafka; print(aiokafka.__version__)"): 0.8.0
  • kafka-python version (python -c "import kafka; print(kafka.__version__)"):
  • Kafka Broker version (kafka-topics.sh --version):
  • Other information (Confluent Cloud version, etc.):
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant