docs: documentation about delete endpoint (influxdata#189)

bednar · web-flow · commit bf0abd74ad3e · 2021-01-26T13:56:16.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,9 @@
 1. [#183](https://github.com/influxdata/influxdb-client-python/pull/183): Fixes to DataFrame writing.
 1. [#181](https://github.com/influxdata/influxdb-client-python/pull/181): Encode Point whole numbers without trailing `.0`
 
+### Documentation
+1. [#189](https://github.com/influxdata/influxdb-client-python/pull/189): Updated docs about `DeleteApi`.
+
 ## 1.13.0 [2020-12-04]
 
 ### Features
diff --git a/README.rst b/README.rst
@@ -65,6 +65,9 @@ InfluxDB 2.0 client features
     - `How to efficiently import large dataset`_
     - `Efficiency write data from IOT sensor`_
     - `How to use Jupyter + Pandas + InfluxDB 2`_
+- Advanced Usage
+    - `Gzip support`_
+    - `Delete data`_
 
 Installation
 ------------
@@ -898,6 +901,34 @@ Gzip support
 
 .. marker-gzip-end
 
+Delete data
+^^^^^^^^^^^
+.. marker-delete-start
+
+The `delete_api.py <influxdb_client/client/delete_api.py>`_ supports deletes `points <https://v2.docs.influxdata.com/v2.0/reference/glossary/#point>`_ from an InfluxDB bucket.
+
+.. code-block:: python
+
+    from influxdb_client import InfluxDBClient
+
+    client = InfluxDBClient(url="http://localhost:8086", token="my-token")
+
+    delete_api = client.delete_api()
+
+    """
+    Delete Data
+    """
+    start = "1970-01-01T00:00:00Z"
+    stop = "2021-02-01T00:00:00Z"
+    delete_api.delete(start, stop, '_measurement="my_measurement"', bucket='my-bucket', org='my-org')
+
+    """
+    Close client
+    """
+    client.__del__()
+
+.. marker-delete-end
+
 InfluxDB 1.8 API compatibility
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/docs/api.rst b/docs/api.rst
@@ -57,6 +57,9 @@ TasksApi
    :members:
 
 DeleteApi
-""""""""
+"""""""""
 .. autoclass:: influxdb_client.DeleteApi
    :members:
+
+.. autoclass:: influxdb_client.domain.DeletePredicateRequest
+   :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,7 +31,7 @@ def setup(app):
 
 
 project = 'influxdb_client'
-copyright = '2019, Bonitoo.io'
+copyright = '2019 InfluxData, Inc'
 author = 'Robert Hajek, Jakub Bednar'
 
 autoclass_content = 'both'
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -22,6 +22,12 @@ Write
   :start-after: marker-writes-start
   :end-before: marker-writes-end
 
+Delete data
+^^^^^^^^^^^
+.. include:: ../README.rst
+  :start-after: marker-delete-start
+  :end-before: marker-delete-end
+
 Gzip support
 ^^^^^^^^^^^^
 .. include:: ../README.rst
diff --git a/influxdb_client/__init__.py b/influxdb_client/__init__.py
@@ -268,6 +268,7 @@
 
 from influxdb_client.client.authorizations_api import AuthorizationsApi
 from influxdb_client.client.bucket_api import BucketsApi
+from influxdb_client.client.delete_api import DeleteApi
 from influxdb_client.client.labels_api import LabelsApi
 from influxdb_client.client.organizations_api import OrganizationsApi
 from influxdb_client.client.query_api import QueryApi
