Updated opensearch-php to reflect the latest OpenSearch API spec (2025-03-14)

Signed-off-by: GitHub <[email protected]>

Author: dblock

CHANGELOG.md

@@ -10,6 +10,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Fixed
 ### Security
 ### Updated APIs
+- Updated opensearch-php APIs to reflect [opensearch-api-specification@c070795](https://github.com/opensearch-project/opensearch-api-specification/commit/c0707952df2846e8e04a533ec5453883771e885a)
 
 ## [2.4.3]
 ### Added

src/OpenSearch/Client.php

@@ -37,6 +37,7 @@
 use OpenSearch\Namespaces\IsmNamespace;
 use OpenSearch\Namespaces\KnnNamespace;
 use OpenSearch\Namespaces\ListNamespace;
+use OpenSearch\Namespaces\LtrNamespace;
 use OpenSearch\Namespaces\MlNamespace;
 use OpenSearch\Namespaces\MonitoringNamespace;
 use OpenSearch\Namespaces\NodesNamespace;
@@ -207,6 +208,11 @@ class Client
      */
     protected $list;
 
+    /**
+     * @var LtrNamespace
+     */
+    protected $ltr;
+
     /**
      * @var MlNamespace
      */
@@ -370,6 +376,7 @@ public function __construct(
         $this->ism = new IsmNamespace($transport, $this->endpointFactory);
         $this->knn = new KnnNamespace($transport, $this->endpointFactory);
         $this->list = new ListNamespace($transport, $this->endpointFactory);
+        $this->ltr = new LtrNamespace($transport, $this->endpointFactory);
         $this->ml = new MlNamespace($transport, $this->endpointFactory);
         // @phpstan-ignore new.deprecated, property.deprecated
         $this->monitoring = new MonitoringNamespace($transport, $this->endpointFactory);
@@ -1962,6 +1969,13 @@ public function list(): ListNamespace
     {
         return $this->list;
     }
+    /**
+     * Returns the ltr namespace
+     */
+    public function ltr(): LtrNamespace
+    {
+        return $this->ltr;
+    }
     /**
      * Returns the ml namespace
      */

src/OpenSearch/Endpoints/Ltr/Stats.php

@@ -0,0 +1,86 @@
+<?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\Ltr;
+
+use OpenSearch\Endpoints\AbstractEndpoint;
+
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
+class Stats extends AbstractEndpoint
+{
+    protected $node_id;
+    protected $stat;
+
+    public function getURI(): string
+    {
+        $node_id = $this->node_id ?? null;
+        $stat = $this->stat ?? null;
+        if (isset($node_id) && isset($stat)) {
+            return "/_plugins/_ltr/$node_id/stats/$stat";
+        }
+        if (isset($node_id)) {
+            return "/_plugins/_ltr/$node_id/stats";
+        }
+        if (isset($stat)) {
+            return "/_plugins/_ltr/stats/$stat";
+        }
+        return "/_plugins/_ltr/stats";
+    }
+
+    public function getParamWhitelist(): array
+    {
+        return [
+            'timeout',
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
+        ];
+    }
+
+    public function getMethod(): string
+    {
+        return 'GET';
+    }
+
+    public function setNodeId($node_id): static
+    {
+        if (isset($node_id) !== true) {
+            return $this;
+        }
+        if (is_array($node_id) === true) {
+            $node_id = implode(",", $node_id);
+        }
+        $this->node_id = $node_id;
+
+        return $this;
+    }
+
+    public function setStat($stat): static
+    {
+        if (isset($stat) !== true) {
+            return $this;
+        }
+        if (is_array($stat) === true) {
+            $stat = implode(",", $stat);
+        }
+        $this->stat = $stat;
+
+        return $this;
+    }
+}

src/OpenSearch/Namespaces/ClusterNamespace.php

@@ -551,7 +551,7 @@ public function reroute(array $params = [])
      * $params['metric']                    = (array) Limits the information returned to only the specified metrics.
      * $params['index']                     = (array)
      * $params['allow_no_indices']          = (boolean) Whether to ignore a wildcard index expression that resolves into no concrete indexes. This includes the `_all` string or when no indexes have been specified.
-     * $params['cluster_manager_timeout']   = (string) The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+     * $params['cluster_manager_timeout']   = (string) The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
      * $params['expand_wildcards']          = (any)
      * $params['flat_settings']             = (boolean) Returns settings in a flat format. (Default = false)
      * $params['ignore_unavailable']        = (boolean) Whether the specified concrete indexes should be ignored when unavailable (missing or closed).

src/OpenSearch/Namespaces/LtrNamespace.php

@@ -0,0 +1,55 @@
+<?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\Namespaces;
+
+use OpenSearch\Endpoints\Ltr\Stats;
+
+/**
+ * Class LtrNamespace
+ *
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
+class LtrNamespace extends AbstractNamespace
+{
+    /**
+     * Provides information about the current status of the LTR plugin.
+     *
+     * $params['node_id']     = (array) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
+     * $params['stat']        = (array) Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.
+     * $params['timeout']     = (string) The time in milliseconds to wait for a response.
+     * $params['pretty']      = (boolean) Whether to pretty format the returned JSON response. (Default = false)
+     * $params['human']       = (boolean) Whether to return human readable values for statistics. (Default = true)
+     * $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 "-".
+     *
+     * @param array $params Associative array of parameters
+     * @return array
+     */
+    public function stats(array $params = [])
+    {
+        $node_id = $this->extractArgument($params, 'node_id');
+        $stat = $this->extractArgument($params, 'stat');
+
+        $endpoint = $this->endpointFactory->getEndpoint(Stats::class);
+        $endpoint->setParams($params);
+        $endpoint->setNodeId($node_id);
+        $endpoint->setStat($stat);
+
+        return $this->performRequest($endpoint);
+    }
+
+}

src/OpenSearch/Namespaces/TasksNamespace.php

@@ -35,11 +35,11 @@ class TasksNamespace extends AbstractNamespace
     /**
      * Cancels a task, if it can be cancelled through an API.
      *
-     * $params['task_id']             = (string) ID of the task.
-     * $params['actions']             = (any) Comma-separated list or wildcard expression of actions used to limit the request.
-     * $params['nodes']               = (array) Comma-separated list of node IDs or names used to limit the request.
-     * $params['parent_task_id']      = (string) Parent task ID used to limit the tasks.
-     * $params['wait_for_completion'] = (boolean) Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false (Default = false)
+     * $params['task_id']             = (string) The ID of the task.
+     * $params['actions']             = (any) A comma-separated list of actions that should be returned. Keep empty to return all.
+     * $params['nodes']               = (array) A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.
+     * $params['parent_task_id']      = (string) Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
+     * $params['wait_for_completion'] = (boolean) Waits for the matching task to complete. When `true`, the request is blocked until the task has completed. (Default = false)
      * $params['pretty']              = (boolean) Whether to pretty format the returned JSON response. (Default = false)
      * $params['human']               = (boolean) Whether to return human readable values for statistics. (Default = true)
      * $params['error_trace']         = (boolean) Whether to include the stack trace of returned errors. (Default = false)
@@ -63,9 +63,9 @@ public function cancel(array $params = [])
     /**
      * Returns information about a task.
      *
-     * $params['task_id']             = (string) ID of the task.
-     * $params['timeout']             = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error.
-     * $params['wait_for_completion'] = (boolean) If `true`, the request blocks until the task has completed. (Default = false)
+     * $params['task_id']             = (string) The ID of the task.
+     * $params['timeout']             = (string) The amount of time to wait for a response.
+     * $params['wait_for_completion'] = (boolean) Waits for the matching task to complete. When `true`, the request is blocked until the task has completed. (Default = false)
      * $params['pretty']              = (boolean) Whether to pretty format the returned JSON response. (Default = false)
      * $params['human']               = (boolean) Whether to return human readable values for statistics. (Default = true)
      * $params['error_trace']         = (boolean) Whether to include the stack trace of returned errors. (Default = false)
@@ -89,13 +89,13 @@ public function get(array $params = [])
     /**
      * Returns a list of tasks.
      *
-     * $params['actions']             = (any) Comma-separated list or wildcard expression of actions used to limit the request.
-     * $params['detailed']            = (boolean) If `true`, the response includes detailed information about shard recoveries. (Default = false)
-     * $params['group_by']            = (enum) Key used to group tasks in the response. (Options = nodes,none,parents)
-     * $params['nodes']               = (array) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
-     * $params['parent_task_id']      = (string) Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`.
-     * $params['timeout']             = (string) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
-     * $params['wait_for_completion'] = (boolean) If `true`, the request blocks until the operation is complete. (Default = false)
+     * $params['actions']             = (any) A comma-separated list of actions that should be returned. Keep empty to return all.
+     * $params['detailed']            = (boolean) When `true`, the response includes detailed information about shard recoveries. (Default = false)
+     * $params['group_by']            = (enum) Groups tasks by parent/child relationships or nodes. (Options = nodes,none,parents)
+     * $params['nodes']               = (array) A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.
+     * $params['parent_task_id']      = (string) Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
+     * $params['timeout']             = (string) The amount of time to wait for a response.
+     * $params['wait_for_completion'] = (boolean) Waits for the matching task to complete. When `true`, the request is blocked until the task has completed. (Default = false)
      * $params['pretty']              = (boolean) Whether to pretty format the returned JSON response. (Default = false)
      * $params['human']               = (boolean) Whether to return human readable values for statistics. (Default = true)
      * $params['error_trace']         = (boolean) Whether to include the stack trace of returned errors. (Default = false)