elasticsearch-api 7.17.1 → 8.1.0

data/lib/elasticsearch/api/actions/scripts_painless_execute.rb

@@ -27,14 +27,16 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The script to execute
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.17/painless-execute-api.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/painless/8.1/painless-execute-api.html
       #
       def scripts_painless_execute(arguments = {})
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         arguments = arguments.clone
 
-        method = if arguments[:body]
+        method = if body
                    Elasticsearch::API::HTTP_POST
                  else
                    Elasticsearch::API::HTTP_GET
@@ -43,8 +45,9 @@ module Elasticsearch
         path   = "_scripts/painless/_execute"
         params = {}
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
     end
   end

data/lib/elasticsearch/api/actions/scroll.rb

@@ -31,16 +31,18 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-request-body.html#request-body-search-scroll
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-request-body.html#request-body-search-scroll
       #
       def scroll(arguments = {})
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         arguments = arguments.clone
 
         _scroll_id = arguments.delete(:scroll_id)
 
-        method = if arguments[:body]
+        method = if body
                    Elasticsearch::API::HTTP_POST
                  else
                    Elasticsearch::API::HTTP_GET
@@ -51,20 +53,12 @@ module Elasticsearch
                  else
                    "_search/scroll"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:scroll, [
-        :scroll,
-        :scroll_id,
-        :rest_total_hits_as_int
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/search.rb

@@ -21,7 +21,6 @@ module Elasticsearch
       # Returns results matching a query.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
       # @option arguments [String] :analyzer The analyzer to use for the query string
       # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
       # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
@@ -54,7 +53,7 @@ module Elasticsearch
       # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
-      # @option arguments [Boolean] :track_total_hits Indicate if the number of documents that match the query should be tracked
+      # @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
       # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
@@ -68,90 +67,35 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition using the Query DSL
       #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-search.html
       #
       def search(arguments = {})
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         arguments = arguments.clone
         arguments[:index] = UNDERSCORE_ALL if !arguments[:index] && arguments[:type]
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
-        method = if arguments[:body]
+        method = if body
                    Elasticsearch::API::HTTP_POST
                  else
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path   = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
-                 elsif _index
+        path   = if _index
                    "#{Utils.__listify(_index)}/_search"
                  else
                    "_search"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:search, [
-        :analyzer,
-        :analyze_wildcard,
-        :ccs_minimize_roundtrips,
-        :default_operator,
-        :df,
-        :explain,
-        :stored_fields,
-        :docvalue_fields,
-        :from,
-        :ignore_unavailable,
-        :ignore_throttled,
-        :allow_no_indices,
-        :expand_wildcards,
-        :lenient,
-        :preference,
-        :q,
-        :routing,
-        :scroll,
-        :search_type,
-        :size,
-        :sort,
-        :_source,
-        :_source_excludes,
-        :_source_includes,
-        :terminate_after,
-        :stats,
-        :suggest_field,
-        :suggest_mode,
-        :suggest_size,
-        :suggest_text,
-        :timeout,
-        :track_scores,
-        :track_total_hits,
-        :allow_partial_search_results,
-        :typed_keys,
-        :version,
-        :seq_no_primary_term,
-        :request_cache,
-        :batched_reduce_size,
-        :max_concurrent_shard_requests,
-        :pre_filter_shard_size,
-        :rest_total_hits_as_int,
-        :min_compatible_shard_node
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/search_mvt.rb

@@ -38,7 +38,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body Search request body.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-vector-tile-api.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-vector-tile-api.html
       #
       def search_mvt(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -49,6 +49,8 @@ module Elasticsearch
 
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         arguments = arguments.clone
 
         _index = arguments.delete(:index)
@@ -63,23 +65,12 @@ module Elasticsearch
 
         method = Elasticsearch::API::HTTP_POST
         path   = "#{Utils.__listify(_index)}/_mvt/#{Utils.__listify(_field)}/#{Utils.__listify(_zoom)}/#{Utils.__listify(_x)}/#{Utils.__listify(_y)}"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:search_mvt, [
-        :exact_bounds,
-        :extent,
-        :grid_precision,
-        :grid_type,
-        :size,
-        :track_total_hits
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/search_shards.rb

@@ -29,11 +29,13 @@ module Elasticsearch
       # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-shards.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-shards.html
       #
       def search_shards(arguments = {})
         headers = arguments.delete(:headers) || {}
 
+        body = nil
+
         arguments = arguments.clone
 
         _index = arguments.delete(:index)
@@ -44,23 +46,12 @@ module Elasticsearch
                  else
                    "_search_shards"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:search_shards, [
-        :preference,
-        :routing,
-        :local,
-        :ignore_unavailable,
-        :allow_no_indices,
-        :expand_wildcards
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/search_template.rb

@@ -21,7 +21,6 @@ module Elasticsearch
       # Allows to use the Mustache language to pre-render a search definition.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
       # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@@ -38,56 +37,31 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition template and its params (*Required*)
       #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-template.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-template.html
       #
       def search_template(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         arguments = arguments.clone
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = Elasticsearch::API::HTTP_POST
-        path   = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search/template"
-                 elsif _index
+        path   = if _index
                    "#{Utils.__listify(_index)}/_search/template"
                  else
                    "_search/template"
                  end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        params = Utils.process_params(arguments)
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:search_template, [
-        :ignore_unavailable,
-        :ignore_throttled,
-        :allow_no_indices,
-        :expand_wildcards,
-        :preference,
-        :routing,
-        :scroll,
-        :search_type,
-        :explain,
-        :profile,
-        :typed_keys,
-        :rest_total_hits_as_int,
-        :ccs_minimize_roundtrips
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb

@@ -0,0 +1,57 @@
+# 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 API
+    module SearchableSnapshots
+      module Actions
+        # Retrieve node-level cache statistics about searchable snapshots.
+        # 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 [List] :node_id 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, leave empty to get information from all nodes
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/searchable-snapshots-apis.html
+        #
+        def cache_stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_searchable_snapshots/#{Utils.__listify(_node_id)}/cache/stats"
+                   else
+                     "_searchable_snapshots/cache/stats"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/{indices/flush_synced.rb → searchable_snapshots/clear_cache.rb}

@@ -17,54 +17,43 @@
 
 module Elasticsearch
   module API
-    module Indices
+    module SearchableSnapshots
       module Actions
-        # Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead
+        # Clear the cache of searchable snapshots.
+        # 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 [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
+        # @option arguments [List] :index A comma-separated list of index names
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # *Deprecation notice*:
-        # Synced flush is deprecated and will be removed in 8.0. Use flush instead.
-        # Deprecated since version 7.6.0
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/searchable-snapshots-apis.html
         #
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-synced-flush-api.html
-        #
-        def flush_synced(arguments = {})
+        def clear_cache(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _index
-                     "#{Utils.__listify(_index)}/_flush/synced"
+                     "#{Utils.__listify(_index)}/_searchable_snapshots/cache/clear"
                    else
-                     "_flush/synced"
+                     "_searchable_snapshots/cache/clear"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-          else
-            perform_request(method, path, params, body, headers).body
-          end
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:flush_synced, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb

@@ -0,0 +1,60 @@
+# 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 API
+    module SearchableSnapshots
+      module Actions
+        # Mount a snapshot as a searchable index.
+        #
+        # @option arguments [String] :repository The name of the repository containing the snapshot of the index to mount
+        # @option arguments [String] :snapshot The name of the snapshot of the index to mount
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @option arguments [String] :storage Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The restore configuration for mounting the snapshot as searchable (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/searchable-snapshots-api-mount-snapshot.html
+        #
+        def mount(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          _snapshot = arguments.delete(:snapshot)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_mount"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb

@@ -0,0 +1,54 @@
+# 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 API
+    module SearchableSnapshots
+      module Actions
+        # Retrieve shard-level statistics about searchable snapshots.
+        #
+        # @option arguments [List] :index A comma-separated list of index names
+        # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/searchable-snapshots-apis.html
+        #
+        def stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_searchable_snapshots/stats"
+                   else
+                     "_searchable_snapshots/stats"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/authenticate.rb

@@ -0,0 +1,46 @@
+# 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 API
+    module Security
+      module Actions
+        # Enables authentication as a user and retrieve information about the authenticated user.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/security-api-authenticate.html
+        #
+        def authenticate(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_security/_authenticate"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end