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

…4-11-14) (#238) Signed-off-by: GitHub <noreply@github.com> Co-authored-by: dblock <dblock@users.noreply.github.com>
opensearch-project · Nov 14, 2024 · 6b08b16 · 6b08b16
1 parent f78f215
commit 6b08b16
Show file tree

Hide file tree

Showing 247 changed files with 1,588 additions and 1,219 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,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@6bb1fed](https://github.com/opensearch-project/opensearch-api-specification/commit/6bb1fed0a2c7cf094a5ecfdb01f0306a4b9f8eba)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@07e329e](https://github.com/opensearch-project/opensearch-api-specification/commit/07e329e8d01fd0576de6a0a3c35412fd5a9163db)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@1db1840](https://github.com/opensearch-project/opensearch-api-specification/commit/1db184063a463c5180a2cc824b1efc1aeebfd5eb)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@cb320b5](https://github.com/opensearch-project/opensearch-api-specification/commit/cb320b5482551c4f28afa26ff0d1653332699722)

diff --git a/src/OpenSearch/Client.php b/src/OpenSearch/Client.php
diff --git a/src/OpenSearch/Endpoints/AsynchronousSearch/Search.php b/src/OpenSearch/Endpoints/AsynchronousSearch/Search.php
@@ -47,7 +47,7 @@ public function getMethod(): string
         return 'POST';
     }
 
-    public function setBody($body): Search
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Bulk.php b/src/OpenSearch/Endpoints/Bulk.php
@@ -70,7 +70,7 @@ public function getMethod(): string
         return 'POST';
     }
 
-    public function setBody($body): Bulk
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;
@@ -89,4 +89,5 @@ public function setBody($body): Bulk
         }
         return $this;
     }
+
 }
diff --git a/src/OpenSearch/Endpoints/BulkStream.php b/src/OpenSearch/Endpoints/BulkStream.php
@@ -66,7 +66,7 @@ public function getMethod(): string
         return 'PUT';
     }
 
-    public function setBody($body): BulkStream
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;
@@ -85,4 +85,5 @@ public function setBody($body): BulkStream
         }
         return $this;
     }
+
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Aliases.php b/src/OpenSearch/Endpoints/Cat/Aliases.php
@@ -62,7 +62,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setName($name): Aliases
+    public function setName($name): static
     {
         if (isset($name) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cat/Allocation.php b/src/OpenSearch/Endpoints/Cat/Allocation.php
@@ -64,7 +64,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setNodeId($node_id): Allocation
+    public function setNodeId($node_id): static
     {
         if (isset($node_id) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cat/Fielddata.php b/src/OpenSearch/Endpoints/Cat/Fielddata.php
@@ -62,7 +62,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setFields($fields): Fielddata
+    public function setFields($fields): static
     {
         if (isset($fields) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cat/PitSegments.php b/src/OpenSearch/Endpoints/Cat/PitSegments.php
@@ -49,7 +49,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setBody($body): PitSegments
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cat/Snapshots.php b/src/OpenSearch/Endpoints/Cat/Snapshots.php
@@ -64,7 +64,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setRepository($repository): Snapshots
+    public function setRepository($repository): static
     {
         if (isset($repository) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cat/Templates.php b/src/OpenSearch/Endpoints/Cat/Templates.php
@@ -63,7 +63,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setName($name): Templates
+    public function setName($name): static
     {
         if (isset($name) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cat/ThreadPool.php b/src/OpenSearch/Endpoints/Cat/ThreadPool.php
@@ -64,7 +64,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setThreadPoolPatterns($thread_pool_patterns): ThreadPool
+    public function setThreadPoolPatterns($thread_pool_patterns): static
     {
         if (isset($thread_pool_patterns) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/ClearScroll.php b/src/OpenSearch/Endpoints/ClearScroll.php
@@ -59,7 +59,7 @@ public function getMethod(): string
         return 'DELETE';
     }
 
-    public function setBody($body): ClearScroll
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;
@@ -69,7 +69,7 @@ public function setBody($body): ClearScroll
         return $this;
     }
 
-    public function setScrollId($scroll_id): ClearScroll
+    public function setScrollId($scroll_id): static
     {
         if (isset($scroll_id) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/AllocationExplain.php b/src/OpenSearch/Endpoints/Cluster/AllocationExplain.php
@@ -51,7 +51,7 @@ public function getMethod(): string
         return isset($this->body) ? 'POST' : 'GET';
     }
 
-    public function setBody($body): AllocationExplain
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/DeleteComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/DeleteComponentTemplate.php
@@ -59,7 +59,7 @@ public function getMethod(): string
         return 'DELETE';
     }
 
-    public function setName($name): DeleteComponentTemplate
+    public function setName($name): static
     {
         if (isset($name) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/DeleteWeightedRouting.php b/src/OpenSearch/Endpoints/Cluster/DeleteWeightedRouting.php
@@ -43,7 +43,7 @@ public function getMethod(): string
         return 'DELETE';
     }
 
-    public function setBody($body): DeleteWeightedRouting
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/ExistsComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/ExistsComponentTemplate.php
@@ -59,7 +59,7 @@ public function getMethod(): string
         return 'HEAD';
     }
 
-    public function setName($name): ExistsComponentTemplate
+    public function setName($name): static
     {
         if (isset($name) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/GetComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/GetComponentTemplate.php
@@ -58,7 +58,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setName($name): GetComponentTemplate
+    public function setName($name): static
     {
         if (isset($name) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/GetDecommissionAwareness.php b/src/OpenSearch/Endpoints/Cluster/GetDecommissionAwareness.php
@@ -50,7 +50,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setAwarenessAttributeName($awareness_attribute_name): GetDecommissionAwareness
+    public function setAwarenessAttributeName($awareness_attribute_name): static
     {
         if (isset($awareness_attribute_name) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/GetWeightedRouting.php b/src/OpenSearch/Endpoints/Cluster/GetWeightedRouting.php
@@ -50,7 +50,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setAttribute($attribute): GetWeightedRouting
+    public function setAttribute($attribute): static
     {
         if (isset($attribute) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/PutComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/PutComponentTemplate.php
@@ -60,7 +60,7 @@ public function getMethod(): string
         return 'PUT';
     }
 
-    public function setBody($body): PutComponentTemplate
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;
@@ -70,7 +70,7 @@ public function setBody($body): PutComponentTemplate
         return $this;
     }
 
-    public function setName($name): PutComponentTemplate
+    public function setName($name): static
     {
         if (isset($name) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/PutDecommissionAwareness.php b/src/OpenSearch/Endpoints/Cluster/PutDecommissionAwareness.php
@@ -52,7 +52,7 @@ public function getMethod(): string
         return 'PUT';
     }
 
-    public function setAwarenessAttributeName($awareness_attribute_name): PutDecommissionAwareness
+    public function setAwarenessAttributeName($awareness_attribute_name): static
     {
         if (isset($awareness_attribute_name) !== true) {
             return $this;
@@ -62,7 +62,7 @@ public function setAwarenessAttributeName($awareness_attribute_name): PutDecommi
         return $this;
     }
 
-    public function setAwarenessAttributeValue($awareness_attribute_value): PutDecommissionAwareness
+    public function setAwarenessAttributeValue($awareness_attribute_value): static
     {
         if (isset($awareness_attribute_value) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/PutSettings.php b/src/OpenSearch/Endpoints/Cluster/PutSettings.php
@@ -53,7 +53,7 @@ public function getMethod(): string
         return 'PUT';
     }
 
-    public function setBody($body): PutSettings
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/PutWeightedRouting.php b/src/OpenSearch/Endpoints/Cluster/PutWeightedRouting.php
@@ -50,7 +50,7 @@ public function getMethod(): string
         return 'PUT';
     }
 
-    public function setBody($body): PutWeightedRouting
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;
@@ -60,7 +60,7 @@ public function setBody($body): PutWeightedRouting
         return $this;
     }
 
-    public function setAttribute($attribute): PutWeightedRouting
+    public function setAttribute($attribute): static
     {
         if (isset($attribute) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/Reroute.php b/src/OpenSearch/Endpoints/Cluster/Reroute.php
@@ -56,7 +56,7 @@ public function getMethod(): string
         return 'POST';
     }
 
-    public function setBody($body): Reroute
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/State.php b/src/OpenSearch/Endpoints/Cluster/State.php
@@ -68,7 +68,7 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setMetric($metric): State
+    public function setMetric($metric): static
     {
         if (isset($metric) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Cluster/Stats.php b/src/OpenSearch/Endpoints/Cluster/Stats.php
@@ -28,11 +28,21 @@
  */
 class Stats extends AbstractEndpoint
 {
+    protected $index_metric;
+    protected $metric;
     protected $node_id;
 
     public function getURI(): string
     {
+        $index_metric = $this->index_metric ?? null;
+        $metric = $this->metric ?? null;
         $node_id = $this->node_id ?? null;
+        if (isset($metric) && isset($index_metric) && isset($node_id)) {
+            return "/_cluster/stats/$metric/$index_metric/nodes/$node_id";
+        }
+        if (isset($metric) && isset($node_id)) {
+            return "/_cluster/stats/$metric/nodes/$node_id";
+        }
         if (isset($node_id)) {
             return "/_cluster/stats/nodes/$node_id";
         }
@@ -57,7 +67,33 @@ public function getMethod(): string
         return 'GET';
     }
 
-    public function setNodeId($node_id): Stats
+    public function setIndexMetric($index_metric): static
+    {
+        if (isset($index_metric) !== true) {
+            return $this;
+        }
+        if (is_array($index_metric) === true) {
+            $index_metric = implode(",", $index_metric);
+        }
+        $this->index_metric = $index_metric;
+
+        return $this;
+    }
+
+    public function setMetric($metric): static
+    {
+        if (isset($metric) !== true) {
+            return $this;
+        }
+        if (is_array($metric) === true) {
+            $metric = implode(",", $metric);
+        }
+        $this->metric = $metric;
+
+        return $this;
+    }
+
+    public function setNodeId($node_id): static
     {
         if (isset($node_id) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Count.php b/src/OpenSearch/Endpoints/Count.php
@@ -67,7 +67,7 @@ public function getMethod(): string
         return isset($this->body) ? 'POST' : 'GET';
     }
 
-    public function setBody($body): Count
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/Create.php b/src/OpenSearch/Endpoints/Create.php
@@ -69,7 +69,7 @@ public function getMethod(): string
         return 'PUT';
     }
 
-    public function setBody($body): Create
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/DanglingIndices/DeleteDanglingIndex.php b/src/OpenSearch/Endpoints/DanglingIndices/DeleteDanglingIndex.php
@@ -60,7 +60,7 @@ public function getMethod(): string
         return 'DELETE';
     }
 
-    public function setIndexUuid($index_uuid): DeleteDanglingIndex
+    public function setIndexUuid($index_uuid): static
     {
         if (isset($index_uuid) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/DanglingIndices/ImportDanglingIndex.php b/src/OpenSearch/Endpoints/DanglingIndices/ImportDanglingIndex.php
@@ -60,7 +60,7 @@ public function getMethod(): string
         return 'POST';
     }
 
-    public function setIndexUuid($index_uuid): ImportDanglingIndex
+    public function setIndexUuid($index_uuid): static
     {
         if (isset($index_uuid) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/DeleteByQuery.php b/src/OpenSearch/Endpoints/DeleteByQuery.php
@@ -89,7 +89,7 @@ public function getMethod(): string
         return 'POST';
     }
 
-    public function setBody($body): DeleteByQuery
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/DeleteByQueryRethrottle.php b/src/OpenSearch/Endpoints/DeleteByQueryRethrottle.php
@@ -59,7 +59,7 @@ public function getMethod(): string
         return 'POST';
     }
 
-    public function setTaskId($task_id): DeleteByQueryRethrottle
+    public function setTaskId($task_id): static
     {
         if (isset($task_id) !== true) {
             return $this;

diff --git a/src/OpenSearch/Endpoints/DeletePit.php b/src/OpenSearch/Endpoints/DeletePit.php
@@ -43,7 +43,7 @@ public function getMethod(): string
         return 'DELETE';
     }
 
-    public function setBody($body): DeletePit
+    public function setBody($body): static
     {
         if (isset($body) !== true) {
             return $this;