Fixes for REST API tests

Author: sethmlarson

elasticsearch/_async/client/__init__.py

@@ -34,14 +34,15 @@
 from elastic_transport import (
     AsyncTransport,
     BaseNode,
+    HeadApiResponse,
     NodeConfig,
     NodePool,
     NodeSelector,
     Serializer,
-    TransportError,
 )
 from elastic_transport.client_utils import DEFAULT, DefaultType
 
+from ...exceptions import ApiError
 from ...serializer import DEFAULT_SERIALIZERS
 from ._base import (
     BaseClient,
@@ -456,7 +457,7 @@ async def ping(
         filter_path: Optional[Union[List[str], str]] = None,
         human: Optional[bool] = None,
         pretty: Optional[bool] = None,
-    ) -> bool:
+    ) -> Any:
         """
         Returns basic information about the cluster.
 
@@ -479,9 +480,9 @@ async def ping(
         __headers = {"accept": "application/json"}
         try:
             resp = await self._perform_request("HEAD", __target, headers=__headers)
-            return bool(resp)
-        except TransportError:
-            return False
+            return resp
+        except ApiError as e:
+            return HeadApiResponse(meta=e.meta)
 
     # AUTO-GENERATED-API-DEFINITIONS #
 
@@ -2089,7 +2090,6 @@ async def info(
     @_rewrite_parameters(
         body_fields=True,
         parameter_aliases={"_source": "source"},
-        ignore_deprecated_options=True,
     )
     async def knn_search(
         self,

elasticsearch/_async/client/ml.py

@@ -960,6 +960,7 @@ async def get_buckets(
         filter_path: Optional[Union[List[str], str]] = None,
         from_: Optional[int] = None,
         human: Optional[bool] = None,
+        page: Optional[Any] = None,
         pretty: Optional[bool] = None,
         size: Optional[int] = None,
         sort: Optional[Any] = None,
@@ -973,18 +974,18 @@ async def get_buckets(
         :param job_id: Identifier for the anomaly detection job.
         :param timestamp: The timestamp of a single bucket result. If you do not specify
             this parameter, the API returns information about all buckets.
-        :param anomaly_score: Returns buckets with anomaly scores greater or equal than
-            this value.
-        :param desc: If `true`, the buckets are sorted in descending order.
-        :param end: Returns buckets with timestamps earlier than this time. `-1` means
-            it is unset and results are not limited to specific timestamps.
-        :param exclude_interim: If `true`, the output excludes interim results.
-        :param expand: If true, the output includes anomaly records.
+        :param anomaly_score: Refer to the description for the `anomaly_score` query
+            parameter.
+        :param desc: Refer to the description for the `desc` query parameter.
+        :param end: Refer to the description for the `end` query parameter.
+        :param exclude_interim: Refer to the description for the `exclude_interim` query
+            parameter.
+        :param expand: Refer to the description for the `expand` query parameter.
         :param from_: Skips the specified number of buckets.
+        :param page:
         :param size: Specifies the maximum number of buckets to obtain.
-        :param sort: Specifies the sort field for the requested buckets.
-        :param start: Returns buckets with timestamps after this time. `-1` means it
-            is unset and results are not limited to specific timestamps.
+        :param sort: Refer to the desription for the `sort` query parameter.
+        :param start: Refer to the description for the `start` query parameter.
         """
         if job_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'job_id'")
@@ -1014,6 +1015,8 @@ async def get_buckets(
             __query["from"] = from_
         if human is not None:
             __query["human"] = human
+        if page is not None:
+            __body["page"] = page
         if pretty is not None:
             __query["pretty"] = pretty
         if size is not None:
@@ -2812,10 +2815,10 @@ async def put_job(
         *,
         job_id: Any,
         analysis_config: Any,
-        background_persist_interval: Any,
         data_description: Any,
         allow_lazy_open: Optional[bool] = None,
         analysis_limits: Optional[Any] = None,
+        background_persist_interval: Optional[Any] = None,
         custom_settings: Optional[Any] = None,
         daily_model_snapshot_retention_after_days: Optional[int] = None,
         datafeed_config: Optional[Any] = None,
@@ -2842,12 +2845,6 @@ async def put_job(
         :param analysis_config: Specifies how to analyze the data. After you create a
             job, you cannot change the analysis configuration; all the properties are
             informational.
-        :param background_persist_interval: Advanced configuration option. The time between
-            each periodic persistence of the model. The default value is a randomized
-            value between 3 to 4 hours, which avoids all jobs persisting at exactly the
-            same time. The smallest allowed value is 1 hour. For very large models (several
-            GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval`
-            value too low.
         :param data_description: Defines the format of the input data when you send data
             to the job by using the post data API. Note that when configure a datafeed,
             these properties are automatically set. When data is received via the post
@@ -2866,6 +2863,12 @@ async def put_job(
             the mathematical models in memory. These limits are approximate and can be
             set per job. They do not control the memory used by other processes, for
             example the Elasticsearch Java processes.
+        :param background_persist_interval: Advanced configuration option. The time between
+            each periodic persistence of the model. The default value is a randomized
+            value between 3 to 4 hours, which avoids all jobs persisting at exactly the
+            same time. The smallest allowed value is 1 hour. For very large models (several
+            GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval`
+            value too low.
         :param custom_settings: Advanced configuration option. Contains custom meta data
             about the job.
         :param daily_model_snapshot_retention_after_days: Advanced configuration option,
@@ -2913,25 +2916,21 @@ async def put_job(
             raise ValueError("Empty value passed for parameter 'job_id'")
         if analysis_config is None:
             raise ValueError("Empty value passed for parameter 'analysis_config'")
-        if background_persist_interval is None:
-            raise ValueError(
-                "Empty value passed for parameter 'background_persist_interval'"
-            )
         if data_description is None:
             raise ValueError("Empty value passed for parameter 'data_description'")
         __path = f"/_ml/anomaly_detectors/{_quote(job_id)}"
         __body: Dict[str, Any] = {}
         __query: Dict[str, Any] = {}
         if analysis_config is not None:
             __body["analysis_config"] = analysis_config
-        if background_persist_interval is not None:
-            __body["background_persist_interval"] = background_persist_interval
         if data_description is not None:
             __body["data_description"] = data_description
         if allow_lazy_open is not None:
             __body["allow_lazy_open"] = allow_lazy_open
         if analysis_limits is not None:
             __body["analysis_limits"] = analysis_limits
+        if background_persist_interval is not None:
+            __body["background_persist_interval"] = background_persist_interval
         if custom_settings is not None:
             __body["custom_settings"] = custom_settings
         if daily_model_snapshot_retention_after_days is not None:

elasticsearch/_sync/client/__init__.py

@@ -33,15 +33,16 @@
 
 from elastic_transport import (
     BaseNode,
+    HeadApiResponse,
     NodeConfig,
     NodePool,
     NodeSelector,
     Serializer,
     Transport,
-    TransportError,
 )
 from elastic_transport.client_utils import DEFAULT, DefaultType
 
+from ...exceptions import ApiError
 from ...serializer import DEFAULT_SERIALIZERS
 from ._base import (
     BaseClient,
@@ -456,7 +457,7 @@ def ping(
         filter_path: Optional[Union[List[str], str]] = None,
         human: Optional[bool] = None,
         pretty: Optional[bool] = None,
-    ) -> bool:
+    ) -> Any:
         """
         Returns basic information about the cluster.
 
@@ -479,9 +480,9 @@ def ping(
         __headers = {"accept": "application/json"}
         try:
             resp = self._perform_request("HEAD", __target, headers=__headers)
-            return bool(resp)
-        except TransportError:
-            return False
+            return resp
+        except ApiError as e:
+            return HeadApiResponse(meta=e.meta)
 
     # AUTO-GENERATED-API-DEFINITIONS #
 
@@ -2071,7 +2072,6 @@ def info(
     @_rewrite_parameters(
         body_fields=True,
         parameter_aliases={"_source": "source"},
-        ignore_deprecated_options=True,
     )
     def knn_search(
         self,

elasticsearch/_sync/client/ml.py

@@ -948,6 +948,7 @@ def get_buckets(
         filter_path: Optional[Union[List[str], str]] = None,
         from_: Optional[int] = None,
         human: Optional[bool] = None,
+        page: Optional[Any] = None,
         pretty: Optional[bool] = None,
         size: Optional[int] = None,
         sort: Optional[Any] = None,
@@ -961,18 +962,18 @@ def get_buckets(
         :param job_id: Identifier for the anomaly detection job.
         :param timestamp: The timestamp of a single bucket result. If you do not specify
             this parameter, the API returns information about all buckets.
-        :param anomaly_score: Returns buckets with anomaly scores greater or equal than
-            this value.
-        :param desc: If `true`, the buckets are sorted in descending order.
-        :param end: Returns buckets with timestamps earlier than this time. `-1` means
-            it is unset and results are not limited to specific timestamps.
-        :param exclude_interim: If `true`, the output excludes interim results.
-        :param expand: If true, the output includes anomaly records.
+        :param anomaly_score: Refer to the description for the `anomaly_score` query
+            parameter.
+        :param desc: Refer to the description for the `desc` query parameter.
+        :param end: Refer to the description for the `end` query parameter.
+        :param exclude_interim: Refer to the description for the `exclude_interim` query
+            parameter.
+        :param expand: Refer to the description for the `expand` query parameter.
         :param from_: Skips the specified number of buckets.
+        :param page:
         :param size: Specifies the maximum number of buckets to obtain.
-        :param sort: Specifies the sort field for the requested buckets.
-        :param start: Returns buckets with timestamps after this time. `-1` means it
-            is unset and results are not limited to specific timestamps.
+        :param sort: Refer to the desription for the `sort` query parameter.
+        :param start: Refer to the description for the `start` query parameter.
         """
         if job_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'job_id'")
@@ -1002,6 +1003,8 @@ def get_buckets(
             __query["from"] = from_
         if human is not None:
             __query["human"] = human
+        if page is not None:
+            __body["page"] = page
         if pretty is not None:
             __query["pretty"] = pretty
         if size is not None:
@@ -2770,10 +2773,10 @@ def put_job(
         *,
         job_id: Any,
         analysis_config: Any,
-        background_persist_interval: Any,
         data_description: Any,
         allow_lazy_open: Optional[bool] = None,
         analysis_limits: Optional[Any] = None,
+        background_persist_interval: Optional[Any] = None,
         custom_settings: Optional[Any] = None,
         daily_model_snapshot_retention_after_days: Optional[int] = None,
         datafeed_config: Optional[Any] = None,
@@ -2800,12 +2803,6 @@ def put_job(
         :param analysis_config: Specifies how to analyze the data. After you create a
             job, you cannot change the analysis configuration; all the properties are
             informational.
-        :param background_persist_interval: Advanced configuration option. The time between
-            each periodic persistence of the model. The default value is a randomized
-            value between 3 to 4 hours, which avoids all jobs persisting at exactly the
-            same time. The smallest allowed value is 1 hour. For very large models (several
-            GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval`
-            value too low.
         :param data_description: Defines the format of the input data when you send data
             to the job by using the post data API. Note that when configure a datafeed,
             these properties are automatically set. When data is received via the post
@@ -2824,6 +2821,12 @@ def put_job(
             the mathematical models in memory. These limits are approximate and can be
             set per job. They do not control the memory used by other processes, for
             example the Elasticsearch Java processes.
+        :param background_persist_interval: Advanced configuration option. The time between
+            each periodic persistence of the model. The default value is a randomized
+            value between 3 to 4 hours, which avoids all jobs persisting at exactly the
+            same time. The smallest allowed value is 1 hour. For very large models (several
+            GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval`
+            value too low.
         :param custom_settings: Advanced configuration option. Contains custom meta data
             about the job.
         :param daily_model_snapshot_retention_after_days: Advanced configuration option,
@@ -2871,25 +2874,21 @@ def put_job(
             raise ValueError("Empty value passed for parameter 'job_id'")
         if analysis_config is None:
             raise ValueError("Empty value passed for parameter 'analysis_config'")
-        if background_persist_interval is None:
-            raise ValueError(
-                "Empty value passed for parameter 'background_persist_interval'"
-            )
         if data_description is None:
             raise ValueError("Empty value passed for parameter 'data_description'")
         __path = f"/_ml/anomaly_detectors/{_quote(job_id)}"
         __body: Dict[str, Any] = {}
         __query: Dict[str, Any] = {}
         if analysis_config is not None:
             __body["analysis_config"] = analysis_config
-        if background_persist_interval is not None:
-            __body["background_persist_interval"] = background_persist_interval
         if data_description is not None:
             __body["data_description"] = data_description
         if allow_lazy_open is not None:
             __body["allow_lazy_open"] = allow_lazy_open
         if analysis_limits is not None:
             __body["analysis_limits"] = analysis_limits
+        if background_persist_interval is not None:
+            __body["background_persist_interval"] = background_persist_interval
         if custom_settings is not None:
             __body["custom_settings"] = custom_settings
         if daily_model_snapshot_retention_after_days is not None:

elasticsearch/_sync/client/utils.py

@@ -255,7 +255,7 @@ def _rewrite_parameters(
     body_name: Optional[str] = None,
     body_fields: bool = False,
     parameter_aliases: Optional[Dict[str, str]] = None,
-    ignore_deprecated_options: Optional[Union[bool, Set[str]]] = None,
+    ignore_deprecated_options: Optional[Set[str]] = None,
 ) -> Callable[[Callable[..., RT]], Callable[..., RT]]:
     def wrapper(api: Callable[..., RT]) -> Callable[..., RT]:
         @wraps(api)
@@ -264,8 +264,7 @@ def wrapped(*args: Any, **kwargs: Any) -> RT:
 
             # We merge 'params' first as transport options can be specified using params.
             if "params" in kwargs and (
-                ignore_deprecated_options is not True
-                or ignore_deprecated_options is not None
+                not ignore_deprecated_options
                 or "params" not in ignore_deprecated_options
             ):
                 params = kwargs.pop("params")
@@ -277,15 +276,14 @@ def wrapped(*args: Any, **kwargs: Any) -> RT:
                         )
                     _merge_kwargs_no_duplicates(kwargs, params)
 
-            if ignore_deprecated_options is not True:
+            maybe_transport_options = _TRANSPORT_OPTIONS.intersection(kwargs)
+            if maybe_transport_options:
                 transport_options = {}
-                options_to_skip: Set[str] = (
-                    ignore_deprecated_options
-                    if isinstance(ignore_deprecated_options, set)
-                    else set()
-                )
-                for option in _TRANSPORT_OPTIONS:
-                    if option in options_to_skip:
+                for option in maybe_transport_options:
+                    if (
+                        ignore_deprecated_options
+                        and option in ignore_deprecated_options
+                    ):
                         continue
                     try:
                         option_rename = option
@@ -315,7 +313,9 @@ def wrapped(*args: Any, **kwargs: Any) -> RT:
                         client = namespaced_client(client)
                     args = (client,) + args[1:]
 
-            if "body" in kwargs and ignore_deprecated_options is not True:
+            if "body" in kwargs and (
+                not ignore_deprecated_options or "body" not in ignore_deprecated_options
+            ):
                 body = kwargs.pop("body")
                 if body is not None:
                     if body_name:

test_elasticsearch/test_server/test_rest_api_spec.py

@@ -40,7 +40,7 @@
 
 # some params had to be changed in python, keep track of them so we can rename
 # those in the tests accordingly
-PARAMS_RENAMES = {"type": "doc_type", "from": "from_"}
+PARAMS_RENAMES = {"from": "from_"}
 API_PARAMS_RENAMES = {
     "snapshot.create_repository": {"repository": "name"},
     "snapshot.delete_repository": {"repository": "name"},