[API] Adds experimental endpoint fleet.global_checkpoints

Author: picandocodigo

elasticsearch-api/utils/thor/generator/files_helper.rb

@@ -46,7 +46,7 @@ def self.files(api)
 
       XPACK_ENDPOINTS = [
         'autoscaling', 'cross_cluster_replication', 'ccr', 'data_frame_transform_deprecated',
-        'enrich', 'eql', 'ilm', 'logstash', 'migration', 'watcher', 'slm'
+        'enrich', 'eql', 'fleet', 'ilm', 'logstash', 'migration', 'watcher', 'slm'
       ]
       XPACK_ENDPOINTS_REGEXP = /data_stream|ml_|reload_search_analyzers|transform/
 

elasticsearch-xpack/lib/elasticsearch/xpack.rb

@@ -160,6 +160,10 @@ def text_structure
       def logstash
         @logstash ||= xpack.logstash
       end
+
+      def fleet
+        @fleet ||= xpack.fleet
+      end
     end
   end
 end if defined?(Elasticsearch::Transport::Client)

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/fleet/global_checkpoints.rb

@@ -0,0 +1,66 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Fleet
+        module Actions
+          # Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
+          # This functionality is Experimental and may be changed or removed
+          # completely in a future release. Elastic will take a best effort approach
+          # to fix any issues, but experimental features are not subject to the
+          # support SLA of official GA features.
+          #
+          # @option arguments [String] :index The name of the index.
+          # @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints
+          # @option arguments [List] :checkpoints Comma separated list of checkpoints
+          # @option arguments [Time] :timeout Timeout to wait for global checkpoint to advance
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see [TODO]
+          #
+          def global_checkpoints(arguments = {})
+            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _index = arguments.delete(:index)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "#{Elasticsearch::API::Utils.__listify(_index)}/_fleet/global_checkpoints"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:global_checkpoints, [
+            :wait_for_advance,
+            :checkpoints,
+            :timeout
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/fleet/params_registry.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Fleet
+        module Actions
+          module ParamsRegistry
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            PARAMS = {}
+
+            # Register an action with its list of valid params.
+            #
+            # @example Register the action.
+            #   ParamsRegistry.register(:benchmark, [ :verbose ])
+            #
+            # @param [ Symbol ] action The action to register.
+            # @param [ Array[Symbol] ] valid_params The list of valid params.
+            #
+            # @since 7.4.0
+            def register(action, valid_params)
+              PARAMS[action.to_sym] = valid_params
+            end
+
+            # Get the list of valid params for a given action.
+            #
+            # @example Get the list of valid params.
+            #   ParamsRegistry.get(:benchmark)
+            #
+            # @param [ Symbol ] action The action.
+            #
+            # @return [ Array<Symbol> ] The list of valid params for the action.
+            #
+            # @since 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/namespace/fleet.rb

@@ -0,0 +1,34 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Fleet
+        module Actions; end
+
+        class FleetClient
+          include Elasticsearch::API::Common::Client, Elasticsearch::API::Common::Client::Base, Fleet::Actions
+        end
+
+        def fleet
+          @fleet ||= FleetClient.new(self)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/fleet/global_checkpoints_spec.rb

@@ -0,0 +1,44 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'client#fleet.global_checkpoints' do
+  let(:expected_args) do
+    [
+      'GET',
+      'foo/_fleet/global_checkpoints',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.fleet.global_checkpoints(index: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::XPack::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.fleet.global_checkpoints
+    }.to raise_exception(ArgumentError)
+  end
+end