Generated Endpoints Using OpenSearch API Specifications: Phase II

Signed-off-by: saimedhi <[email protected]>
opensearch-project · Jul 8, 2024 · 782242f · 782242f
1 parent 96580eb
commit 782242f
Show file tree

Hide file tree

Showing 205 changed files with 7,444 additions and 2,189 deletions.
diff --git a/src/OpenSearch/Client.php b/src/OpenSearch/Client.php
diff --git a/src/OpenSearch/Endpoints/Bulk.php b/src/OpenSearch/Endpoints/Bulk.php
@@ -26,6 +26,9 @@
 use OpenSearch\Serializers\SerializerInterface;
 use Traversable;
 
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
 class Bulk extends AbstractEndpoint
 {
     public function __construct(SerializerInterface $serializer)
@@ -36,7 +39,6 @@ public function __construct(SerializerInterface $serializer)
     public function getURI(): string
     {
         $index = $this->index ?? null;
-
         if (isset($index)) {
             return "/$index/_bulk";
         }
@@ -46,15 +48,20 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'wait_for_active_shards',
-            'refresh',
-            'routing',
-            'timeout',
             '_source',
             '_source_excludes',
             '_source_includes',
             'pipeline',
-            'require_alias'
+            'refresh',
+            'require_alias',
+            'routing',
+            'timeout',
+            'wait_for_active_shards',
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
         ];
     }
 

diff --git a/src/OpenSearch/Endpoints/Cat/Aliases.php b/src/OpenSearch/Endpoints/Cat/Aliases.php
@@ -42,13 +42,13 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
+            'expand_wildcards',
             'format',
-            'local',
             'h',
             'help',
+            'local',
             's',
             'v',
-            'expand_wildcards',
             'pretty',
             'human',
             'error_trace',

diff --git a/src/OpenSearch/Endpoints/Cat/AllPitSegments.php b/src/OpenSearch/Endpoints/Cat/AllPitSegments.php
@@ -0,0 +1,51 @@
+<?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\Cat;
+
+use OpenSearch\Endpoints\AbstractEndpoint;
+
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
+class AllPitSegments extends AbstractEndpoint
+{
+    public function getURI(): string
+    {
+        return "/_cat/pit_segments/_all";
+    }
+
+    public function getParamWhitelist(): array
+    {
+        return [
+            'bytes',
+            'format',
+            'h',
+            'help',
+            's',
+            'v',
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
+        ];
+    }
+
+    public function getMethod(): string
+    {
+        return 'GET';
+    }
+}
diff --git a/src/OpenSearch/Endpoints/Cat/Allocation.php b/src/OpenSearch/Endpoints/Cat/Allocation.php
@@ -42,13 +42,13 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'format',
             'bytes',
-            'local',
-            'master_timeout',
             'cluster_manager_timeout',
+            'format',
             'h',
             'help',
+            'local',
+            'master_timeout',
             's',
             'v',
             'pretty',

diff --git a/src/OpenSearch/Endpoints/Cat/ClusterManager.php b/src/OpenSearch/Endpoints/Cat/ClusterManager.php
@@ -23,6 +23,9 @@
 
 use OpenSearch\Endpoints\AbstractEndpoint;
 
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
 class ClusterManager extends AbstractEndpoint
 {
     public function getURI(): string
@@ -33,18 +36,29 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'format',
-            'local',
             'cluster_manager_timeout',
+            'format',
             'h',
             'help',
+            'local',
+            'master_timeout',
             's',
-            'v'
+            'v',
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Fielddata.php b/src/OpenSearch/Endpoints/Cat/Fielddata.php
@@ -42,13 +42,13 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'format',
             'bytes',
+            'fields',
+            'format',
             'h',
             'help',
             's',
             'v',
-            'fields',
             'pretty',
             'human',
             'error_trace',

diff --git a/src/OpenSearch/Endpoints/Cat/Help.php b/src/OpenSearch/Endpoints/Cat/Help.php
@@ -36,8 +36,6 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'help',
-            's',
             'pretty',
             'human',
             'error_trace',

diff --git a/src/OpenSearch/Endpoints/Cat/Indices.php b/src/OpenSearch/Endpoints/Cat/Indices.php
@@ -40,20 +40,20 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'format',
             'bytes',
-            'local',
-            'master_timeout',
             'cluster_manager_timeout',
+            'expand_wildcards',
+            'format',
             'h',
             'health',
             'help',
+            'include_unloaded_segments',
+            'local',
+            'master_timeout',
             'pri',
             's',
             'time',
             'v',
-            'include_unloaded_segments',
-            'expand_wildcards',
             'pretty',
             'human',
             'error_trace',

diff --git a/src/OpenSearch/Endpoints/Cat/Master.php b/src/OpenSearch/Endpoints/Cat/Master.php
@@ -24,7 +24,10 @@
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**
- * @deprecated use \OpenSearch\Endpoints\Cat\ClusterManager instead
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
+/**
+ * @deprecated To promote inclusive language, please use '/_cat/cluster_manager' instead.
  */
 class Master extends AbstractEndpoint
 {
@@ -36,21 +39,27 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
+            'cluster_manager_timeout',
             'format',
-            'local',
-            'master_timeout',
             'h',
             'help',
+            'local',
+            'master_timeout',
             's',
             'v',
-            'cluster_manager_timeout'
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+
     protected function getParamDeprecation(): array
     {
         return ['master_timeout' => 'cluster_manager_timeout'];

diff --git a/src/OpenSearch/Endpoints/Cat/NodeAttrs.php b/src/OpenSearch/Endpoints/Cat/NodeAttrs.php
@@ -36,12 +36,12 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'format',
-            'local',
-            'master_timeout',
             'cluster_manager_timeout',
+            'format',
             'h',
             'help',
+            'local',
+            'master_timeout',
             's',
             'v',
             'pretty',

diff --git a/src/OpenSearch/Endpoints/Cat/Nodes.php b/src/OpenSearch/Endpoints/Cat/Nodes.php
@@ -37,13 +37,13 @@ public function getParamWhitelist(): array
     {
         return [
             'bytes',
+            'cluster_manager_timeout',
             'format',
             'full_id',
-            'local',
-            'master_timeout',
-            'cluster_manager_timeout',
             'h',
             'help',
+            'local',
+            'master_timeout',
             's',
             'time',
             'v',

diff --git a/src/OpenSearch/Endpoints/Cat/PendingTasks.php b/src/OpenSearch/Endpoints/Cat/PendingTasks.php
@@ -36,12 +36,12 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'format',
-            'local',
-            'master_timeout',
             'cluster_manager_timeout',
+            'format',
             'h',
             'help',
+            'local',
+            'master_timeout',
             's',
             'time',
             'v',

diff --git a/src/OpenSearch/Endpoints/Cat/PitSegments.php b/src/OpenSearch/Endpoints/Cat/PitSegments.php
@@ -0,0 +1,61 @@
+<?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\Cat;
+
+use OpenSearch\Endpoints\AbstractEndpoint;
+
+/**
+ * NOTE: This file is autogenerated using util/GenerateEndpoints.php
+ */
+class PitSegments extends AbstractEndpoint
+{
+    public function getURI(): string
+    {
+        return "/_cat/pit_segments";
+    }
+
+    public function getParamWhitelist(): array
+    {
+        return [
+            'bytes',
+            'format',
+            'h',
+            'help',
+            's',
+            'v',
+            'pretty',
+            'human',
+            'error_trace',
+            'source',
+            'filter_path'
+        ];
+    }
+
+    public function getMethod(): string
+    {
+        return 'GET';
+    }
+
+    public function setBody($body): PitSegments
+    {
+        if (isset($body) !== true) {
+            return $this;
+        }
+        $this->body = $body;
+
+        return $this;
+    }
+}
diff --git a/src/OpenSearch/Endpoints/Cat/Plugins.php b/src/OpenSearch/Endpoints/Cat/Plugins.php
@@ -36,12 +36,12 @@ public function getURI(): string
     public function getParamWhitelist(): array
     {
         return [
-            'format',
-            'local',
-            'master_timeout',
             'cluster_manager_timeout',
+            'format',
             'h',
             'help',
+            'local',
+            'master_timeout',
             's',
             'v',
             'pretty',