From 9398975f98575305e3e327a2261f0d9203c23d85 Mon Sep 17 00:00:00 2001 From: jaydm26 <49287135+jaydm26@users.noreply.github.com> Date: Tue, 27 Sep 2022 21:51:17 +0200 Subject: [PATCH] Adds various client docs within Opensearch client (#204) Signed-off-by: Jay Mehta Signed-off-by: Jay Mehta Signed-off-by: Jay Mehta Signed-off-by: Jay Mehta Co-authored-by: Jay Mehta --- docs/source/api-ref.md | 1 + docs/source/api-ref/client.md | 35 +++++++++++++++++-- docs/source/api-ref/clients/cat_client.md | 5 +++ docs/source/api-ref/clients/cluster_client.md | 5 +++ .../clients/dangling_indices_client.md | 5 +++ .../source/api-ref/clients/features_client.md | 5 +++ docs/source/api-ref/clients/indices_client.md | 5 +++ docs/source/api-ref/clients/ingest_client.md | 5 +++ docs/source/api-ref/clients/nodes_client.md | 5 +++ .../api-ref/clients/opensearch_client.md | 5 +++ docs/source/api-ref/clients/remote_client.md | 5 +++ .../source/api-ref/clients/snapshot_client.md | 5 +++ docs/source/api-ref/clients/tasks_client.md | 5 +++ docs/source/index.md | 2 ++ 14 files changed, 90 insertions(+), 3 deletions(-) create mode 100644 docs/source/api-ref/clients/cat_client.md create mode 100644 docs/source/api-ref/clients/cluster_client.md create mode 100644 docs/source/api-ref/clients/dangling_indices_client.md create mode 100644 docs/source/api-ref/clients/features_client.md create mode 100644 docs/source/api-ref/clients/indices_client.md create mode 100644 docs/source/api-ref/clients/ingest_client.md create mode 100644 docs/source/api-ref/clients/nodes_client.md create mode 100644 docs/source/api-ref/clients/opensearch_client.md create mode 100644 docs/source/api-ref/clients/remote_client.md create mode 100644 docs/source/api-ref/clients/snapshot_client.md create mode 100644 docs/source/api-ref/clients/tasks_client.md diff --git a/docs/source/api-ref.md b/docs/source/api-ref.md index 5d92e038..0a4ac336 100644 --- a/docs/source/api-ref.md +++ b/docs/source/api-ref.md @@ -7,5 +7,6 @@ titlesonly: maxdepth: 2 --- +api-ref/client api-ref/* ``` diff --git a/docs/source/api-ref/client.md b/docs/source/api-ref/client.md index 2ef2d671..ce84a12e 100644 --- a/docs/source/api-ref/client.md +++ b/docs/source/api-ref/client.md @@ -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 ``` diff --git a/docs/source/api-ref/clients/cat_client.md b/docs/source/api-ref/clients/cat_client.md new file mode 100644 index 00000000..05c40d04 --- /dev/null +++ b/docs/source/api-ref/clients/cat_client.md @@ -0,0 +1,5 @@ +# Compact and aligned text (CAT) Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.cat.CatClient +``` diff --git a/docs/source/api-ref/clients/cluster_client.md b/docs/source/api-ref/clients/cluster_client.md new file mode 100644 index 00000000..49856981 --- /dev/null +++ b/docs/source/api-ref/clients/cluster_client.md @@ -0,0 +1,5 @@ +# Cluster Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.cluster.ClusterClient +``` diff --git a/docs/source/api-ref/clients/dangling_indices_client.md b/docs/source/api-ref/clients/dangling_indices_client.md new file mode 100644 index 00000000..54432eb6 --- /dev/null +++ b/docs/source/api-ref/clients/dangling_indices_client.md @@ -0,0 +1,5 @@ +# Dangling Indices Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.dangling_indices.DanglingIndicesClient +``` diff --git a/docs/source/api-ref/clients/features_client.md b/docs/source/api-ref/clients/features_client.md new file mode 100644 index 00000000..d83ac17f --- /dev/null +++ b/docs/source/api-ref/clients/features_client.md @@ -0,0 +1,5 @@ +# Features Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.features.FeaturesClient +``` diff --git a/docs/source/api-ref/clients/indices_client.md b/docs/source/api-ref/clients/indices_client.md new file mode 100644 index 00000000..9c21e978 --- /dev/null +++ b/docs/source/api-ref/clients/indices_client.md @@ -0,0 +1,5 @@ +# Indices Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.indices.IndicesClient +``` diff --git a/docs/source/api-ref/clients/ingest_client.md b/docs/source/api-ref/clients/ingest_client.md new file mode 100644 index 00000000..1b725624 --- /dev/null +++ b/docs/source/api-ref/clients/ingest_client.md @@ -0,0 +1,5 @@ +# Ingest Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.ingest.IngestClient +``` diff --git a/docs/source/api-ref/clients/nodes_client.md b/docs/source/api-ref/clients/nodes_client.md new file mode 100644 index 00000000..bd860212 --- /dev/null +++ b/docs/source/api-ref/clients/nodes_client.md @@ -0,0 +1,5 @@ +# Nodes Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.nodes.NodesClient +``` diff --git a/docs/source/api-ref/clients/opensearch_client.md b/docs/source/api-ref/clients/opensearch_client.md new file mode 100644 index 00000000..15838f29 --- /dev/null +++ b/docs/source/api-ref/clients/opensearch_client.md @@ -0,0 +1,5 @@ +# OpenSearch Client + +```{eval-rst} +.. autoclass:: opensearchpy.OpenSearch +``` diff --git a/docs/source/api-ref/clients/remote_client.md b/docs/source/api-ref/clients/remote_client.md new file mode 100644 index 00000000..90e3b482 --- /dev/null +++ b/docs/source/api-ref/clients/remote_client.md @@ -0,0 +1,5 @@ +# Remote Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.remote.RemoteClient +``` diff --git a/docs/source/api-ref/clients/snapshot_client.md b/docs/source/api-ref/clients/snapshot_client.md new file mode 100644 index 00000000..0337b3d4 --- /dev/null +++ b/docs/source/api-ref/clients/snapshot_client.md @@ -0,0 +1,5 @@ +# Snapshot Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.snapshot.SnapshotClient +``` diff --git a/docs/source/api-ref/clients/tasks_client.md b/docs/source/api-ref/clients/tasks_client.md new file mode 100644 index 00000000..50f5391f --- /dev/null +++ b/docs/source/api-ref/clients/tasks_client.md @@ -0,0 +1,5 @@ +# Tasks Client + +```{eval-rst} +.. autoclass:: opensearchpy.client.tasks.TasksClient +``` diff --git a/docs/source/index.md b/docs/source/index.md index 8d228acf..513d4ab4 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,6 +1,7 @@ # OpenSearch Python Client Documentation ## Table of Contents + ```{toctree} --- maxdepth: 1 @@ -16,4 +17,5 @@ GitHub Repository ``` ```{include} README.md + ```