Skip to content

Commit 99e3104

Browse files
committed
docs: add documentation
1 parent 91ec9a0 commit 99e3104

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

influxdb_client/client/influxdb_client.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(self, url, token: str = None, debug=None, timeout=10_000, enable_gz
3030
Initialize defaults.
3131
3232
:param url: InfluxDB server API url (ex. http://localhost:8086).
33-
:param token: auth token
33+
:param token: ``token`` to authenticate to the InfluxDB API
3434
:param debug: enable verbose logging of http requests
3535
:param timeout: HTTP client timeout setting for a request specified in milliseconds.
3636
If one number provided, it will be total request timeout.
@@ -50,6 +50,8 @@ def __init__(self, url, token: str = None, debug=None, timeout=10_000, enable_gz
5050
:key bool auth_basic: Set this to true to enable basic authentication when talking to a InfluxDB 1.8.x that
5151
does not use auth-enabled but is protected by a reverse proxy with basic authentication.
5252
(defaults to false, don't set to true when talking to InfluxDB 2)
53+
:key str username: ``username`` to authenticate via username and password credentials to the InfluxDB 2.x
54+
:key str password: ``password`` to authenticate via username and password credentials to the InfluxDB 2.x
5355
:key list[str] profilers: list of enabled Flux profilers
5456
"""
5557
super().__init__(url=url, token=token, debug=debug, timeout=timeout, enable_gzip=enable_gzip, org=org,

influxdb_client/client/influxdb_client_async.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def __init__(self, url, token: str = None, org: str = None, debug=None, timeout=
2222
Initialize defaults.
2323
2424
:param url: InfluxDB server API url (ex. http://localhost:8086).
25-
:param token: auth token
25+
:param token: ``token`` to authenticate to the InfluxDB 2.x
2626
:param org: organization name (used as a default in Query, Write and Delete API)
2727
:param debug: enable verbose logging of http requests
2828
:param timeout: The maximal number of milliseconds for the whole HTTP request including
@@ -40,6 +40,8 @@ def __init__(self, url, token: str = None, org: str = None, debug=None, timeout=
4040
:key bool auth_basic: Set this to true to enable basic authentication when talking to a InfluxDB 1.8.x that
4141
does not use auth-enabled but is protected by a reverse proxy with basic authentication.
4242
(defaults to false, don't set to true when talking to InfluxDB 2)
43+
:key str username: ``username`` to authenticate via username and password credentials to the InfluxDB 2.x
44+
:key str password: ``password`` to authenticate via username and password credentials to the InfluxDB 2.x
4345
:key bool allow_redirects: If set to ``False``, do not follow HTTP redirects. ``True`` by default.
4446
:key int max_redirects: Maximum number of HTTP redirects to follow. ``10`` by default.
4547
:key dict client_session_kwargs: Additional configuration arguments for :class:`~aiohttp.ClientSession`

0 commit comments

Comments
 (0)