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

Update security_protocol argument docstring #884

Merged
merged 1 commit into from
Apr 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion aiokafka/consumer/consumer.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,8 @@ class AIOKafkaConsumer:
If set to ``auto``, will attempt to infer the broker version by
probing various APIs. Default: ``auto``
security_protocol (str): Protocol used to communicate with brokers.
Valid values are: ``PLAINTEXT``, ``SSL``. Default: ``PLAINTEXT``.
Valid values are: ``PLAINTEXT``, ``SSL``, ``SASL_PLAINTEXT``,
``SASL_SSL``. Default: ``PLAINTEXT``.
ssl_context (ssl.SSLContext): pre-configured :class:`~ssl.SSLContext`
for wrapping socket connections. Directly passed into asyncio's
:meth:`~asyncio.loop.create_connection`. For more information see
Expand Down
4 changes: 2 additions & 2 deletions aiokafka/producer/producer.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ class AIOKafkaProducer:
If set to ``auto``, will attempt to infer the broker version by
probing various APIs. Default: ``auto``
security_protocol (str): Protocol used to communicate with brokers.
Valid values are: ``PLAINTEXT``, ``SSL``. Default: ``PLAINTEXT``.
Default: ``PLAINTEXT``.
Valid values are: ``PLAINTEXT``, ``SSL``, ``SASL_PLAINTEXT``,
``SASL_SSL``. Default: ``PLAINTEXT``.
ssl_context (ssl.SSLContext): pre-configured :class:`~ssl.SSLContext`
for wrapping socket connections. Directly passed into asyncio's
:meth:`~asyncio.loop.create_connection`. For more
Expand Down