Updated opensearch-py to reflect the latest OpenSearch API spec (2024…

…-05-21) (opensearch-project#747) Signed-off-by: GitHub <[email protected]> Co-authored-by: saimedhi <[email protected]>
saimedhi · May 21, 2024 · 5b40a85 · 5b40a85
1 parent 77313d2
commit 5b40a85
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Fixed
 - Updated code generator to use native OpenAPI specification ([#721](https://github.com/opensearch-project/opensearch-py/pull/721))
 ### Updated APIs
+- Updated opensearch-py APIs to reflect [opensearch-api-specification@b253667](https://github.com/opensearch-project/opensearch-api-specification/commit/b2536673227663e6ba7c757d36e30c7e0e78f684)
 - Updated opensearch-py APIs to reflect [opensearch-api-specification@deeb400](https://github.com/opensearch-project/opensearch-api-specification/commit/deeb4005291dd499d1e637dffb2db9cd3bfb14b6)
 - Updated opensearch-py APIs to reflect [opensearch-api-specification@de939d2](https://github.com/opensearch-project/opensearch-api-specification/commit/de939d2b116ae15f364fae588f67e139198d0c56)
 - Updated opensearch-py APIs to reflect [opensearch-api-specification@d3783f1](https://github.com/opensearch-project/opensearch-api-specification/commit/d3783f1200fdc5799eba861842ee611f2c7e30e7)

diff --git a/opensearchpy/_async/client/cat.py b/opensearchpy/_async/client/cat.py
@@ -669,7 +669,8 @@ async def nodes(
         :arg help: Return help information. Default is false.
         :arg human: Whether to return human readable values for
             statistics.
-        :arg local: Return local information, do not retrieve the state
+        :arg local (Deprecated: This parameter does not cause this API
+            to act locally.): Return local information, do not retrieve the state
             from cluster-manager node. Default is false.
         :arg master_timeout (Deprecated: To promote inclusive language,
             use 'cluster_manager_timeout' instead.): Operation timeout for

diff --git a/opensearchpy/_async/plugins/knn.py b/opensearchpy/_async/plugins/knn.py
@@ -278,17 +278,7 @@ async def stats(
             node you're connecting to, leave empty to get information from all
             nodes.
         :arg stat: Comma-separated list of stats to retrieve; use `_all`
-            or empty string to retrieve all stats. Valid choices are
-            circuit_breaker_triggered, total_load_time, eviction_count, hit_count,
-            miss_count, graph_memory_usage, graph_memory_usage_percentage,
-            graph_index_requests, graph_index_errors, graph_query_requests,
-            graph_query_errors, knn_query_requests, cache_capacity_reached,
-            load_success_count, load_exception_count, indices_in_cache,
-            script_compilations, script_compilation_errors, script_query_requests,
-            script_query_errors, nmslib_initialized, faiss_initialized,
-            model_index_status, indexing_from_model_degraded, training_requests,
-            training_errors, training_memory_usage,
-            training_memory_usage_percentage.
+            or empty string to retrieve all stats.
         :arg error_trace: Whether to include the stack trace of returned
             errors.
         :arg filter_path: Comma-separated list of filters used to reduce

diff --git a/opensearchpy/client/cat.py b/opensearchpy/client/cat.py
@@ -669,7 +669,8 @@ def nodes(
         :arg help: Return help information. Default is false.
         :arg human: Whether to return human readable values for
             statistics.
-        :arg local: Return local information, do not retrieve the state
+        :arg local (Deprecated: This parameter does not cause this API
+            to act locally.): Return local information, do not retrieve the state
             from cluster-manager node. Default is false.
         :arg master_timeout (Deprecated: To promote inclusive language,
             use 'cluster_manager_timeout' instead.): Operation timeout for

diff --git a/opensearchpy/plugins/knn.py b/opensearchpy/plugins/knn.py
@@ -278,17 +278,7 @@ def stats(
             node you're connecting to, leave empty to get information from all
             nodes.
         :arg stat: Comma-separated list of stats to retrieve; use `_all`
-            or empty string to retrieve all stats. Valid choices are
-            circuit_breaker_triggered, total_load_time, eviction_count, hit_count,
-            miss_count, graph_memory_usage, graph_memory_usage_percentage,
-            graph_index_requests, graph_index_errors, graph_query_requests,
-            graph_query_errors, knn_query_requests, cache_capacity_reached,
-            load_success_count, load_exception_count, indices_in_cache,
-            script_compilations, script_compilation_errors, script_query_requests,
-            script_query_errors, nmslib_initialized, faiss_initialized,
-            model_index_status, indexing_from_model_degraded, training_requests,
-            training_errors, training_memory_usage,
-            training_memory_usage_percentage.
+            or empty string to retrieve all stats.
         :arg error_trace: Whether to include the stack trace of returned
             errors.
         :arg filter_path: Comma-separated list of filters used to reduce