Add clarification about auth parameter in ClientSession (#8953)

aio-libs · Aug 31, 2024 · 51ea3b3 · 51ea3b3
1 parent 1d170d3
commit 51ea3b3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CHANGES/6764.doc.rst b/CHANGES/6764.doc.rst
@@ -0,0 +1 @@
+Clarified that auth parameter in ClientSession will persist and be included with any request to any origin, even during redirects to different origins.  -- by :user:`MaximZemskov`.
diff --git a/docs/client_reference.rst b/docs/client_reference.rst
@@ -99,7 +99,10 @@ The client session supports the context manager protocol for self closing.
       Iterable of :class:`str` or :class:`~multidict.istr` (optional)
 
    :param aiohttp.BasicAuth auth: an object that represents HTTP Basic
-                                  Authorization (optional)
+                                  Authorization (optional). It will be included
+                                  with any request to any origin and will not be
+                                  removed, event during redirect to a different
+                                  origin.
 
    :param version: supported HTTP version, ``HTTP 1.1`` by default.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarified that auth parameter in ClientSession will persist and be included with any request to any origin, even during redirects to different origins. -- by :user:`MaximZemskov`.