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

…-01-09)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added option to pass custom headers to 'AWSV4SignerAsyncAuth' ([863](https://github.com/opensearch-project/opensearch-py/pull/863))
 - Added sync and async sample that uses `search_after` parameter ([859](https://github.com/opensearch-project/opensearch-py/pull/859))
 ### Updated APIs
+- Updated opensearch-py APIs to reflect [opensearch-api-specification@2395cb4](https://github.com/opensearch-project/opensearch-api-specification/commit/2395cb472ec5581656aac184f7b20548cd5b06ac)
 ### Changed
 - Small refactor of AWS Signer classes for both sync and async clients ([866](https://github.com/opensearch-project/opensearch-py/pull/866))
 - Small refactor to fix overwriting the module files when generating apis ([874](https://github.com/opensearch-project/opensearch-py/pull/874))

opensearchpy/_async/client/cluster.py

@@ -84,7 +84,7 @@ async def health(
             concrete indexes that are open, closed or both.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -127,7 +127,7 @@ async def health(
         :arg wait_for_status: One of green, yellow or red. Will wait
             (until the timeout provided) until the status of the cluster changes to
             the one provided or better, i.e. green > yellow > red. By default, will
-            not wait for any status. Valid choices are green, red, yellow.
+            not wait for any status.
         """
         return await self.transport.perform_request(
             "GET",
@@ -162,7 +162,7 @@ async def pending_tasks(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -224,7 +224,7 @@ async def state(
             concrete indexes that are open, closed or both.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg flat_settings: Return settings in flat format. Default is
             false.
@@ -288,7 +288,7 @@ async def stats(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg flat_settings: If `true`, returns settings in flat format.
             Default is false.
@@ -352,7 +352,7 @@ async def reroute(
             explanation of why the commands can or cannot be executed.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -403,7 +403,7 @@ async def get_settings(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg flat_settings: If `true`, returns settings in flat format.
             Default is false.
@@ -456,7 +456,7 @@ async def put_settings(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg flat_settings: Return settings in flat format. Default is
             false.
@@ -492,7 +492,7 @@ async def remote_info(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -530,7 +530,7 @@ async def allocation_explain(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -579,7 +579,7 @@ async def delete_component_template(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -609,6 +609,7 @@ async def delete_component_template(
         "cluster_manager_timeout",
         "error_trace",
         "filter_path",
+        "flat_settings",
         "human",
         "local",
         "master_timeout",
@@ -633,8 +634,10 @@ async def get_component_template(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
+        :arg flat_settings: If `true`, returns settings in flat format.
+            Default is false.
         :arg human: Whether to return human readable values for
             statistics. Default is True.
         :arg local: If `true`, the request retrieves information from
@@ -697,7 +700,7 @@ async def put_component_template(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -751,7 +754,7 @@ async def exists_component_template(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -793,7 +796,7 @@ async def delete_voting_config_exclusions(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -839,7 +842,7 @@ async def post_voting_config_exclusions(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -877,7 +880,7 @@ async def delete_decommission_awareness(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -905,7 +908,7 @@ async def delete_weighted_routing(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -938,7 +941,7 @@ async def get_decommission_awareness(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -981,7 +984,7 @@ async def get_weighted_routing(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -1018,7 +1021,7 @@ async def put_decommission_awareness(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -1061,7 +1064,7 @@ async def put_weighted_routing(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.

opensearchpy/_async/client/dangling_indices.py

@@ -70,7 +70,7 @@ async def delete_dangling_index(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -123,7 +123,7 @@ async def import_dangling_index(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.
@@ -157,7 +157,7 @@ async def list_dangling_indices(
             errors. Default is false.
         :arg filter_path: Used to reduce the response. This parameter
             takes a comma-separated list of filters. It supports using wildcards to
-            match any field or part of a field’s name. You can also exclude fields
+            match any field or part of a field’s name. You can also exclude fields
             with "-".
         :arg human: Whether to return human readable values for
             statistics. Default is True.