Adds various client docs within Opensearch client (#204)

Signed-off-by: Jay Mehta <[email protected]>
Signed-off-by: Jay Mehta <[email protected]>

Signed-off-by: Jay Mehta <[email protected]>
Signed-off-by: Jay Mehta <[email protected]>
Co-authored-by: Jay Mehta <[email protected]>
This commit is contained in:
jaydm26
2022-09-27 15:51:17 -04:00
committed by GitHub
co-authored by Jay Mehta
parent 382f63e033
commit 9398975f98
14 changed files with 90 additions and 3 deletions
+32 -3
View File
@@ -1,5 +1,34 @@
# client
# Clients
```{eval-rst}
.. autoclass:: opensearchpy.OpenSearch
```{toctree}
---
glob:
titlesonly:
maxdepth: 1
---
clients/opensearch_client
```
## Clients within Opensearch
OpenSearch Client includes several clients:
```{toctree}
---
glob:
titlesonly:
maxdepth: 1
---
clients/cat_client
clients/cluster_client
clients/dangling_indices_client
clients/ingest_client
clients/indices_client
clients/nodes_client
clients/remote_client
clients/snapshot_client
clients/tasks_client
clients/features_client
```
@@ -0,0 +1,5 @@
# Compact and aligned text (CAT) Client
```{eval-rst}
.. autoclass:: opensearchpy.client.cat.CatClient
```
@@ -0,0 +1,5 @@
# Cluster Client
```{eval-rst}
.. autoclass:: opensearchpy.client.cluster.ClusterClient
```
@@ -0,0 +1,5 @@
# Dangling Indices Client
```{eval-rst}
.. autoclass:: opensearchpy.client.dangling_indices.DanglingIndicesClient
```
@@ -0,0 +1,5 @@
# Features Client
```{eval-rst}
.. autoclass:: opensearchpy.client.features.FeaturesClient
```
@@ -0,0 +1,5 @@
# Indices Client
```{eval-rst}
.. autoclass:: opensearchpy.client.indices.IndicesClient
```
@@ -0,0 +1,5 @@
# Ingest Client
```{eval-rst}
.. autoclass:: opensearchpy.client.ingest.IngestClient
```
@@ -0,0 +1,5 @@
# Nodes Client
```{eval-rst}
.. autoclass:: opensearchpy.client.nodes.NodesClient
```
@@ -0,0 +1,5 @@
# OpenSearch Client
```{eval-rst}
.. autoclass:: opensearchpy.OpenSearch
```
@@ -0,0 +1,5 @@
# Remote Client
```{eval-rst}
.. autoclass:: opensearchpy.client.remote.RemoteClient
```
@@ -0,0 +1,5 @@
# Snapshot Client
```{eval-rst}
.. autoclass:: opensearchpy.client.snapshot.SnapshotClient
```
@@ -0,0 +1,5 @@
# Tasks Client
```{eval-rst}
.. autoclass:: opensearchpy.client.tasks.TasksClient
```