From 4552db25512b13d8bba9d272423f8c06af04d9f8 Mon Sep 17 00:00:00 2001 From: merlinz01 <158784988+merlinz01@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:04:42 -0500 Subject: [PATCH] Update docs --- docs/source/api-ref/clients/opensearch_client.md | 4 ++++ docs/source/api-ref/connection.md | 6 +++++- opensearchpy/_async/client/__init__.py | 8 +++++--- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/source/api-ref/clients/opensearch_client.md b/docs/source/api-ref/clients/opensearch_client.md index 15838f29a..4c0845df3 100644 --- a/docs/source/api-ref/clients/opensearch_client.md +++ b/docs/source/api-ref/clients/opensearch_client.md @@ -3,3 +3,7 @@ ```{eval-rst} .. autoclass:: opensearchpy.OpenSearch ``` + +```{eval-rst} +.. autoclass:: opensearchpy.AsyncOpenSearch +``` diff --git a/docs/source/api-ref/connection.md b/docs/source/api-ref/connection.md index 8ac0e3ec6..3a6ea4b08 100644 --- a/docs/source/api-ref/connection.md +++ b/docs/source/api-ref/connection.md @@ -1,4 +1,4 @@ -# connection +# Connection Types ```{eval-rst} .. autoclass:: opensearchpy.Connection @@ -12,6 +12,10 @@ .. autoclass:: opensearchpy.Urllib3HttpConnection ``` +```{eval-rst} +.. autoclass:: opensearchpy.AIOHttpConnection +``` + ```{eval-rst} .. autoclass:: opensearchpy.connections ``` \ No newline at end of file diff --git a/opensearchpy/_async/client/__init__.py b/opensearchpy/_async/client/__init__.py index 9cd54d388..24b954989 100644 --- a/opensearchpy/_async/client/__init__.py +++ b/opensearchpy/_async/client/__init__.py @@ -109,7 +109,7 @@ class AsyncOpenSearch(Client): ]) If using SSL, there are several parameters that control how we deal with - certificates (see :class:`~opensearchpy.Urllib3HttpConnection` for + certificates (see :class:`~opensearchpy.AIOHttpConnection` for detailed description of the options):: client = OpenSearch( @@ -123,7 +123,7 @@ class AsyncOpenSearch(Client): ) If using SSL, but don't verify the certs, a warning message is showed - optionally (see :class:`~opensearchpy.Urllib3HttpConnection` for + optionally (see :class:`~opensearchpy.AIOHttpConnection` for detailed description of the options):: client = OpenSearch( @@ -132,12 +132,14 @@ class AsyncOpenSearch(Client): use_ssl=True, # no verify SSL certificates verify_certs=False, + # don't verify the hostname in the certificate + ssl_assert_hostname=False, # don't show warnings about ssl certs verification ssl_show_warn=False ) SSL client authentication is supported - (see :class:`~opensearchpy.Urllib3HttpConnection` for + (see :class:`~opensearchpy.AIOHttpConnection` for detailed description of the options):: client = OpenSearch(