Skip to content

Commit 581d7ed

Browse files
author
Luke Sneeringer
committed
Add a private API warning in the docs.
1 parent 017e5ca commit 581d7ed

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

docs/google-cloud-auth.rst

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -298,14 +298,23 @@ you add the correct scopes for the APIs you want to access:
298298
Advanced Customization
299299
======================
300300

301-
Though the ``google-cloud-python`` library defaults to using `google-auth`_
302-
to sign requests and ``httplib2`` for sending requests,
303-
it is not a strict requirement.
301+
.. warning::
302+
303+
The google-cloud developers want to improve our HTTP handling to
304+
support more situations more easily, and use current tooling.
305+
306+
In order to allow this, this particular mechanism may have to be altered
307+
in a backwards-compatible way. Therefore, the following section should
308+
be considered "private API" that is subject to change.
309+
310+
Though the ``google-cloud-python`` library uses `google-auth`_ to sign
311+
requests and ``httplib2`` for sending requests.
304312

305313
.. _google-auth: http://google-auth.readthedocs.io/en/stable/
306314

307-
The :class:`Client <google.cloud.client.Client>` constructor accepts an optional
308-
``_http`` argument in place of a ``credentials`` object.
315+
This is not a stirct requirement:
316+
The :class:`Client <google.cloud.client.Client>` constructor accepts an
317+
optional ``_http`` argument in place of a ``credentials`` object.
309318
If passed, all HTTP requests made by the client will use your
310319
custom HTTP object.
311320

0 commit comments

Comments
 (0)