Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
merlinz01 committed Nov 14, 2024
1 parent 4415da0 commit 4552db2
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
4 changes: 4 additions & 0 deletions docs/source/api-ref/clients/opensearch_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
```{eval-rst}
.. autoclass:: opensearchpy.OpenSearch
```

```{eval-rst}
.. autoclass:: opensearchpy.AsyncOpenSearch
```
6 changes: 5 additions & 1 deletion docs/source/api-ref/connection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# connection
# Connection Types

```{eval-rst}
.. autoclass:: opensearchpy.Connection
Expand All @@ -12,6 +12,10 @@
.. autoclass:: opensearchpy.Urllib3HttpConnection
```

```{eval-rst}
.. autoclass:: opensearchpy.AIOHttpConnection
```

```{eval-rst}
.. autoclass:: opensearchpy.connections
```
8 changes: 5 additions & 3 deletions opensearchpy/_async/client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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(
Expand All @@ -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(
Expand Down

0 comments on commit 4552db2

Please sign in to comment.