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.

Sign up for GitHub

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 docs for ssl param in client #8403

Merged
merged 2 commits into from
May 8, 2024
Merged

Update docs for ssl param in client #8403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b968b61
Update docs for ssl param in client
aitor-gamarra May 8, 2024
f1d133c
Add CHANGES doc
aitor-gamarra May 8, 2024
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
1 change: 1 addition & 0 deletions CHANGES/8403.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve the docs for the `ssl` params.
12 changes: 6 additions & 6 deletions docs/client_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ The client session supports the context manager protocol for self closing.
read_until_eof=True, \
read_bufsize=None, \
proxy=None, proxy_auth=None,\
timeout=sentinel, ssl=None, \
timeout=sentinel, ssl=True, \
verify_ssl=None, fingerprint=None, \
ssl_context=None, proxy_headers=None, \
server_hostname=None, auto_decompress=None)
Expand Down Expand Up @@ -475,7 +475,7 @@ The client session supports the context manager protocol for self closing.

If :class:`float` is passed it is a *total* timeout (in seconds).

:param ssl: SSL validation mode. ``None`` for default SSL check
:param ssl: SSL validation mode. ``True`` for default SSL check
(:func:`ssl.create_default_context` is used),
``False`` for skip SSL certificate validation,
:class:`aiohttp.Fingerprint` for fingerprint
Expand Down Expand Up @@ -680,7 +680,7 @@ The client session supports the context manager protocol for self closing.
origin=None, \
params=None, \
headers=None, \
proxy=None, proxy_auth=None, ssl=None, \
proxy=None, proxy_auth=None, ssl=True, \
verify_ssl=None, fingerprint=None, \
ssl_context=None, proxy_headers=None, \
compress=0, max_msg_size=4194304)
Expand Down Expand Up @@ -744,7 +744,7 @@ The client session supports the context manager protocol for self closing.
:param aiohttp.BasicAuth proxy_auth: an object that represents proxy HTTP
Basic Authorization (optional)

:param ssl: SSL validation mode. ``None`` for default SSL check
:param ssl: SSL validation mode. ``True`` for default SSL check
(:func:`ssl.create_default_context` is used),
``False`` for skip SSL certificate validation,
:class:`aiohttp.Fingerprint` for fingerprint
Expand Down Expand Up @@ -1050,7 +1050,7 @@ is controlled by *force_close* constructor's parameter).
overridden in subclasses.


.. class:: TCPConnector(*, ssl=None, verify_ssl=True, fingerprint=None, \
.. class:: TCPConnector(*, ssl=True, verify_ssl=True, fingerprint=None, \
use_dns_cache=True, ttl_dns_cache=10, \
family=0, ssl_context=None, local_addr=None, \
resolver=None, keepalive_timeout=sentinel, \
Expand All @@ -1068,7 +1068,7 @@ is controlled by *force_close* constructor's parameter).
Constructor accepts all parameters suitable for
:class:`BaseConnector` plus several TCP-specific ones:

:param ssl: SSL validation mode. ``None`` for default SSL check
:param ssl: SSL validation mode. ``True`` for default SSL check
(:func:`ssl.create_default_context` is used),
``False`` for skip SSL certificate validation,
:class:`aiohttp.Fingerprint` for fingerprint
Expand Down
Loading