[7.x] Document all APIs, add stability warning

2020-10-28 13:49:05 -05:00
parent c1fbdef75e
commit d08860a357
24 changed files with 696 additions and 253 deletions
@@ -15,7 +15,7 @@ consistency and safety**.
    ``from`` and ``doc_type`` instead of ``type`` as parameter names.


-Global options
+Global Options
 --------------

 Some parameters are added by the client itself and can be used in all API
@@ -109,6 +109,30 @@ Elasticsearch

 .. py:module:: elasticsearch.client

+Async Search
+------------
+
+.. autoclass:: AsyncSearchClient
+   :members:
+
+Cat
+---
+
+.. autoclass:: CatClient
+   :members:
+
+Cluster
+-------
+
+.. autoclass:: ClusterClient
+   :members:
+
+Dangling Indices
+----------------
+
+.. autoclass:: DanglingIndicesClient
+   :members:
+
 Indices
 -------

@@ -121,22 +145,16 @@ Ingest
 .. autoclass:: IngestClient
   :members:

-Cluster
-------
-
-.. autoclass:: ClusterClient
-   :members:
-
 Nodes
 -----

 .. autoclass:: NodesClient
   :members:

-Cat
---
+Remote
+------

-.. autoclass:: CatClient
+.. autoclass:: RemoteClient
   :members:

 Snapshot
@@ -150,9 +168,3 @@ Tasks

 .. autoclass:: TasksClient
   :members:
-
-Dangling Indices
----------------
-
-.. autoclass:: DanglingIndicesClient
-   :members: