Updated opensearch-php to reflect the latest OpenSearch API spec (202…

…5-01-02) Signed-off-by: GitHub <[email protected]>
opensearch-project · Jan 2, 2025 · 4b16f69 · 4b16f69
1 parent d750838
commit 4b16f69
Show file tree

Hide file tree

Showing 11 changed files with 421 additions and 204 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Fixed
 - Fixed PHP 8.4 deprecations
 ### Updated APIs
+- Updated opensearch-php APIs to reflect [opensearch-api-specification@24872ec](https://github.com/opensearch-project/opensearch-api-specification/commit/24872ec2a86efc913e4577c88808547c7785f13e)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@ebe0f8a](https://github.com/opensearch-project/opensearch-api-specification/commit/ebe0f8a885f7db7e882d160c101055a5aa70a707)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@398481e](https://github.com/opensearch-project/opensearch-api-specification/commit/398481e5bd1cc590d947c35379c47096f2114f00)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@6bb1fed](https://github.com/opensearch-project/opensearch-api-specification/commit/6bb1fed0a2c7cf094a5ecfdb01f0306a4b9f8eba)

diff --git a/src/OpenSearch/Client.php b/src/OpenSearch/Client.php
@@ -1314,7 +1314,7 @@ public function reindex(array $params = [])
     }
 
     /**
-     * Changes the number of requests per second for a particular Reindex operation.
+     * Changes the number of requests per second for a particular reindex operation.
      *
      * $params['task_id']             = (string) Identifier for the task. (Required)
      * $params['requests_per_second'] = (number) The throttle for this request in sub-requests per second.
@@ -1400,7 +1400,6 @@ public function scriptsPainlessExecute(array $params = [])
      * $params['error_trace']            = (boolean) Whether to include the stack trace of returned errors. (Default = false)
      * $params['source']                 = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
      * $params['filter_path']            = (any) 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 with "-".
-     * $params['body']                   = (array) The scroll ID if not passed by URL or query parameter.
      *
      * @param array $params Associative array of parameters
      * @return array

diff --git a/src/OpenSearch/Endpoints/Cluster/GetComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/GetComponentTemplate.php
@@ -43,6 +43,7 @@ public function getParamWhitelist(): array
     {
         return [
             'cluster_manager_timeout',
+            'flat_settings',
             'local',
             'master_timeout',
             'pretty',

diff --git a/src/OpenSearch/Endpoints/Indices/Upgrade.php b/src/OpenSearch/Endpoints/Indices/Upgrade.php
@@ -57,14 +57,4 @@ public function getMethod(): string
     {
         return 'POST';
     }
-
-    public function setBody($body): static
-    {
-        if (isset($body) !== true) {
-            return $this;
-        }
-        $this->body = $body;
-
-        return $this;
-    }
 }
diff --git a/src/OpenSearch/Endpoints/Ml/Predict.php b/src/OpenSearch/Endpoints/Ml/Predict.php
@@ -16,36 +16,67 @@
 use OpenSearch\Common\Exceptions\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
 class Predict extends AbstractEndpoint
 {
-    /**
-     * @return string[]
-     */
+    protected $algorithm_name;
+    protected $model_id;
+
+    public function getURI(): string
+    {
+        $algorithm_name = $this->algorithm_name ?? null;
+        $model_id = $this->model_id ?? null;
+        if (isset($algorithm_name) && isset($model_id)) {
+            return "/_plugins/_ml/_predict/$algorithm_name/$model_id";
+        }
+        throw new RuntimeException('Missing parameter for the endpoint ml.predict');
+    }
+
     public function getParamWhitelist(): array
     {
-        return [];
+        return [
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
+        ];
     }
 
-    /**
-     * @return string
-     */
-    public function getURI(): string
+    public function getMethod(): string
+    {
+        return 'POST';
+    }
+
+    public function setBody($body): static
     {
-        if ($this->id) {
-            return "/_plugins/_ml/models/$this->id/_predict";
+        if (isset($body) !== true) {
+            return $this;
         }
+        $this->body = $body;
 
-        throw new RuntimeException(
-            'id is required for predict'
-        );
+        return $this;
+    }
 
+    public function setAlgorithmName($algorithm_name): static
+    {
+        if (isset($algorithm_name) !== true) {
+            return $this;
+        }
+        $this->algorithm_name = $algorithm_name;
+
+        return $this;
     }
 
-    /**
-     * @return string
-     */
-    public function getMethod(): string
+    public function setModelId($model_id): static
     {
-        return 'POST';
+        if (isset($model_id) !== true) {
+            return $this;
+        }
+        $this->model_id = $model_id;
+
+        return $this;
     }
 }
diff --git a/src/OpenSearch/Endpoints/Ml/Train.php b/src/OpenSearch/Endpoints/Ml/Train.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+namespace OpenSearch\Endpoints\Ml;
+
+use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Endpoints\AbstractEndpoint;
+
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
+class Train extends AbstractEndpoint
+{
+    protected $algorithm_name;
+
+    public function getURI(): string
+    {
+        $algorithm_name = $this->algorithm_name ?? null;
+        if (isset($algorithm_name)) {
+            return "/_plugins/_ml/_train/$algorithm_name";
+        }
+        throw new RuntimeException('Missing parameter for the endpoint ml.train');
+    }
+
+    public function getParamWhitelist(): array
+    {
+        return [
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
+        ];
+    }
+
+    public function getMethod(): string
+    {
+        return 'POST';
+    }
+
+    public function setBody($body): static
+    {
+        if (isset($body) !== true) {
+            return $this;
+        }
+        $this->body = $body;
+
+        return $this;
+    }
+
+    public function setAlgorithmName($algorithm_name): static
+    {
+        if (isset($algorithm_name) !== true) {
+            return $this;
+        }
+        $this->algorithm_name = $algorithm_name;
+
+        return $this;
+    }
+}
diff --git a/src/OpenSearch/Endpoints/Ml/TrainPredict.php b/src/OpenSearch/Endpoints/Ml/TrainPredict.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+namespace OpenSearch\Endpoints\Ml;
+
+use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Endpoints\AbstractEndpoint;
+
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
+class TrainPredict extends AbstractEndpoint
+{
+    protected $algorithm_name;
+
+    public function getURI(): string
+    {
+        $algorithm_name = $this->algorithm_name ?? null;
+        if (isset($algorithm_name)) {
+            return "/_plugins/_ml/_train_predict/$algorithm_name";
+        }
+        throw new RuntimeException('Missing parameter for the endpoint ml.train_predict');
+    }
+
+    public function getParamWhitelist(): array
+    {
+        return [
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
+        ];
+    }
+
+    public function getMethod(): string
+    {
+        return 'POST';
+    }
+
+    public function setBody($body): static
+    {
+        if (isset($body) !== true) {
+            return $this;
+        }
+        $this->body = $body;
+
+        return $this;
+    }
+
+    public function setAlgorithmName($algorithm_name): static
+    {
+        if (isset($algorithm_name) !== true) {
+            return $this;
+        }
+        $this->algorithm_name = $algorithm_name;
+
+        return $this;
+    }
+}