Skip to content

Commit 587ad89

Browse files
saimedhigithub-actions[bot]
authored andcommitted
Updated opensearch-py to reflect the latest OpenSearch API spec (2024-11-25)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 12c379d commit 587ad89

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+8998
-4386
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
3636
- Fixed the use of `minimum_should_match` with `Bool` to allow the use of string-based value (percent string, combination). ([#780](https://github.com/opensearch-project/opensearch-py/pull/780))
3737
- Fixed incorrect `retry_on_conflict` type ([#795](https://github.com/opensearch-project/opensearch-py/pull/795))
3838
### Updated APIs
39+
- Updated opensearch-py APIs to reflect [opensearch-api-specification@c51aa2e](https://github.com/opensearch-project/opensearch-api-specification/commit/c51aa2e8f031224aff5fda7a4961f5f4a115bed0)
3940
- Updated opensearch-py APIs to reflect [opensearch-api-specification@9d3bc34](https://github.com/opensearch-project/opensearch-api-specification/commit/9d3bc340ccd7d049e7d6e14a4aff2293780cb446)
4041
### Dependencies
4142
- Bump `pytest-asyncio` from <=0.23.7 to <=0.23.8 ([#787](https://github.com/opensearch-project/opensearch-py/pull/787))

opensearchpy/_async/client/__init__.py

Lines changed: 516 additions & 337 deletions
Large diffs are not rendered by default.

opensearchpy/_async/client/cat.py

Lines changed: 270 additions & 224 deletions
Large diffs are not rendered by default.

opensearchpy/_async/client/cluster.py

Lines changed: 220 additions & 169 deletions
Large diffs are not rendered by default.

opensearchpy/_async/client/dangling_indices.py

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -61,25 +61,27 @@ async def delete_dangling_index(
6161
Deletes the specified dangling index.
6262
6363
64-
:arg index_uuid: The UUID of the dangling index
64+
:arg index_uuid: The UUID of the dangling index.
6565
:arg accept_data_loss: Must be set to true in order to delete
66-
the dangling index
66+
the dangling index.
6767
:arg cluster_manager_timeout: Operation timeout for connection
6868
to cluster-manager node.
6969
:arg error_trace: Whether to include the stack trace of returned
70-
errors.
71-
:arg filter_path: Comma-separated list of filters used to reduce
72-
the response.
70+
errors. Default is false.
71+
:arg filter_path: Used to reduce the response. This parameter
72+
takes a comma-separated list of filters. It supports using wildcards to
73+
match any field or part of a field’s name. You can also exclude fields
74+
with "-".
7375
:arg human: Whether to return human readable values for
74-
statistics.
76+
statistics. Default is True.
7577
:arg master_timeout (Deprecated: To promote inclusive language,
76-
use 'cluster_manager_timeout' instead.): Specify timeout for connection
77-
to master
78+
use `cluster_manager_timeout` instead.): Specify timeout for connection
79+
to cluster manager.
7880
:arg pretty: Whether to pretty format the returned JSON
79-
response.
81+
response. Default is false.
8082
:arg source: The URL-encoded request definition. Useful for
8183
libraries that do not accept a request body for non-POST requests.
82-
:arg timeout: Explicit operation timeout
84+
:arg timeout: Explicit operation timeout.
8385
"""
8486
if index_uuid in SKIP_IN_PATH:
8587
raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -112,25 +114,27 @@ async def import_dangling_index(
112114
Imports the specified dangling index.
113115
114116
115-
:arg index_uuid: The UUID of the dangling index
117+
:arg index_uuid: The UUID of the dangling index.
116118
:arg accept_data_loss: Must be set to true in order to import
117-
the dangling index
119+
the dangling index.
118120
:arg cluster_manager_timeout: Operation timeout for connection
119121
to cluster-manager node.
120122
:arg error_trace: Whether to include the stack trace of returned
121-
errors.
122-
:arg filter_path: Comma-separated list of filters used to reduce
123-
the response.
123+
errors. Default is false.
124+
:arg filter_path: Used to reduce the response. This parameter
125+
takes a comma-separated list of filters. It supports using wildcards to
126+
match any field or part of a field’s name. You can also exclude fields
127+
with "-".
124128
:arg human: Whether to return human readable values for
125-
statistics.
129+
statistics. Default is True.
126130
:arg master_timeout (Deprecated: To promote inclusive language,
127-
use 'cluster_manager_timeout' instead.): Specify timeout for connection
128-
to master
131+
use `cluster_manager_timeout` instead.): Specify timeout for connection
132+
to cluster manager.
129133
:arg pretty: Whether to pretty format the returned JSON
130-
response.
134+
response. Default is false.
131135
:arg source: The URL-encoded request definition. Useful for
132136
libraries that do not accept a request body for non-POST requests.
133-
:arg timeout: Explicit operation timeout
137+
:arg timeout: Explicit operation timeout.
134138
"""
135139
if index_uuid in SKIP_IN_PATH:
136140
raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -146,17 +150,19 @@ async def list_dangling_indices(
146150
headers: Any = None,
147151
) -> Any:
148152
"""
149-
Returns all dangling indices.
153+
Returns all dangling indexes.
150154
151155
152156
:arg error_trace: Whether to include the stack trace of returned
153-
errors.
154-
:arg filter_path: Comma-separated list of filters used to reduce
155-
the response.
157+
errors. Default is false.
158+
:arg filter_path: Used to reduce the response. This parameter
159+
takes a comma-separated list of filters. It supports using wildcards to
160+
match any field or part of a field’s name. You can also exclude fields
161+
with "-".
156162
:arg human: Whether to return human readable values for
157-
statistics.
163+
statistics. Default is True.
158164
:arg pretty: Whether to pretty format the returned JSON
159-
response.
165+
response. Default is false.
160166
:arg source: The URL-encoded request definition. Useful for
161167
libraries that do not accept a request body for non-POST requests.
162168
"""

0 commit comments

Comments
 (0)