elasticsearch-api 7.17.11 → 9.0.2

data/lib/elasticsearch/api/actions/esql/async_query_get.rb

@@ -0,0 +1,72 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Esql
+      module Actions
+        # Get async ES|QL query results.
+        # Get the current status and available results or stored results for an ES|QL asynchronous query.
+        # If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.
+        #
+        # @option arguments [String] :id The unique identifier of the query.
+        #  A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.
+        #  A query ID is also provided when the request was submitted with the +keep_on_completion+ parameter set to +true+. (*Required*)
+        # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.
+        #  If +true+, the response will include an extra section under the name +all_columns+ which has the name of all the columns.
+        # @option arguments [Time] :keep_alive The period for which the query and its results are stored in the cluster.
+        #  When this period expires, the query and its results are deleted, even if the query is still ongoing.
+        # @option arguments [Time] :wait_for_completion_timeout The period to wait for the request to finish.
+        #  By default, the request waits for complete query results.
+        #  If the request completes during the period specified in this parameter, complete query results are returned.
+        #  Otherwise, the response returns an +is_running+ value of +true+ and no results.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-get
+        #
+        def async_query_get(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_get' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_query/async/#{Utils.listify(_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/esql/async_query_stop.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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Esql
+      module Actions
+        # Stop async ES|QL query.
+        # This API interrupts the query execution and returns the results so far.
+        # If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.
+        #
+        # @option arguments [String] :id The unique identifier of the query.
+        #  A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.
+        #  A query ID is also provided when the request was submitted with the +keep_on_completion+ parameter set to +true+. (*Required*)
+        # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.
+        #  If +true+, the response will include an extra section under the name +all_columns+ which has the name of all the columns.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-stop
+        #
+        def async_query_stop(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_stop' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_query/async/#{Utils.listify(_id)}/stop"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/esql/query.rb

@@ -0,0 +1,61 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Esql
+      module Actions
+        # Run an ES|QL query.
+        # Get search results for an ES|QL (Elasticsearch query language) query.
+        # This functionality is subject to potential breaking changes within a
+        # minor version, meaning that your referencing code may break when this
+        # library is upgraded.
+        #
+        # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.
+        # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
+        # @option arguments [Boolean] :drop_null_columns Should columns that are entirely +null+ be removed from the +columns+ and +values+ portion of the results?
+        #  Defaults to +false+. If +true+ then the response will include an extra section under the name +all_columns+ which has the name of all columns.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest
+        #
+        def query(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'esql.query' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_query'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -14,80 +14,87 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns information about whether a document exists in an index.
+      # Check a document.
+      # Verify that a document exists.
+      # For example, check to see if a document with the +_id+ 0 exists:
+      # +
+      # HEAD my-index-000001/_doc/0
+      # +
+      # If the document exists, the API returns a status code of +200 - OK+.
+      # If the document doesn’t exist, the API returns +404 - Not Found+.
+      # **Versioning support**
+      # You can use the +version+ parameter to check the document only if its current version is equal to the specified one.
+      # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document.
+      # The old version of the document doesn't disappear immediately, although you won't be able to access it.
+      # Elasticsearch cleans up deleted documents in the background as you continue to index more data.
       #
-      # @option arguments [String] :id The document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) *Deprecated*
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
-      # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
-      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :id A unique document identifier. (*Required*)
+      # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases.
+      #  It supports wildcards (+*+). (*Required*)
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.If it is set to +_local+, the operation will prefer to be run on a local allocated shard when possible.
+      #  If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.
+      #  This can help with "jumping values" when hitting different shards in different refresh states.
+      #  A sample value can be something like the web session ID or the user name.
+      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
+      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
+      #  If this parameter is specified, only these source fields are returned.
+      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
+      #  If no fields are specified, no stored fields are included in the response.
+      #  If this field is specified, the +_source+ parameter defaults to +false+.
+      # @option arguments [Integer] :version Explicit version number for concurrency control.
+      #  The specified version must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # *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/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get
       #
       def exists(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'exists' }
+
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        arguments = arguments.clone
+        body = nil
 
         _id = arguments.delete(:id)
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = Elasticsearch::API::HTTP_HEAD
-        path   = if _index && _type && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}"
-                 else
-                   "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        path   = "#{Utils.listify(_index)}/_doc/#{Utils.listify(_id)}"
+        params = Utils.process_params(arguments)
 
-        body = nil
-
-        Utils.__rescue_from_not_found do
-          perform_request(method, path, params, body, headers).status == 200 ? true : false
+        Utils.rescue_from_not_found do
+          perform_request(method, path, params, body, headers, request_opts).status == 200
         end
       end
 
-      alias_method :exists?, :exists
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:exists, [
-        :stored_fields,
-        :preference,
-        :realtime,
-        :refresh,
-        :routing,
-        :_source,
-        :_source_excludes,
-        :_source_includes,
-        :version,
-        :version_type
-      ].freeze)
+      alias exists? exists
     end
   end
 end

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

@@ -14,75 +14,70 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns information about whether a document source exists in an index.
+      # Check for a document source.
+      # Check whether a document source exists in an index.
+      # For example:
+      # +
+      # HEAD my-index-000001/_source/1
+      # +
+      # A document's source is not available if it is disabled in the mapping.
       #
-      # @option arguments [String] :id The document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0 *Deprecated*
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
-      # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
-      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :id A unique identifier for the document. (*Required*)
+      # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases.
+      #  It supports wildcards (+*+). (*Required*)
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.
+      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
+      # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
+      # @option arguments [Integer] :version The version number for concurrency control.
+      #  It must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # *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/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get
       #
       def exists_source(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'exists_source' }
+
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        arguments = arguments.clone
+        body = nil
 
         _id = arguments.delete(:id)
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = Elasticsearch::API::HTTP_HEAD
-        path   = if _index && _type && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_source"
-                 else
-                   "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        path   = "#{Utils.listify(_index)}/_source/#{Utils.listify(_id)}"
+        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, request_opts)
+        )
       end
 
-      alias_method :exists_source?, :exists_source
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:exists_source, [
-        :preference,
-        :realtime,
-        :refresh,
-        :routing,
-        :_source,
-        :_source_excludes,
-        :_source_includes,
-        :version,
-        :version_type
-      ].freeze)
+      alias exists_source? exists_source
     end
   end
 end

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

@@ -14,85 +14,81 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns information about why a specific matches (or doesn't match) a query.
+      # Explain a document match result.
+      # Get information about why a specific document matches, or doesn't match, a query.
+      # It computes a score explanation for a query and a specific document.
       #
-      # @option arguments [String] :id The document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document *Deprecated*
-      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
-      # @option arguments [String] :analyzer The analyzer for the query string query
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
-      # @option arguments [String] :df The default field for query string query (default: _all)
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
-      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [String] :q Query in the Lucene query string syntax
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
-      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [String] :id The document identifier. (*Required*)
+      # @option arguments [String] :index Index names that are used to limit the request.
+      #  Only a single index name can be provided to this parameter. (*Required*)
+      # @option arguments [String] :analyzer The analyzer to use for the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+.
+      #  This parameter can be used only when the +q+ query string parameter is specified. Server default: OR.
+      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source +True+ or +false+ to return the +_source+ field or not or a list of fields to return.
+      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
+      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
+      #  If this parameter is specified, only these source fields are returned.
+      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return in the response.
+      # @option arguments [String] :q The query in the Lucene query string syntax.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The query definition using the Query DSL
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-explain.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-explain
       #
       def explain(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'explain' }
+
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+        arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        arguments = arguments.clone
+        body = arguments.delete(:body)
 
         _id = arguments.delete(:id)
 
         _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 && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_explain"
-                 else
-                   "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        path   = "#{Utils.listify(_index)}/_explain/#{Utils.listify(_id)}"
+        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, request_opts)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:explain, [
-        :analyze_wildcard,
-        :analyzer,
-        :default_operator,
-        :df,
-        :stored_fields,
-        :lenient,
-        :preference,
-        :q,
-        :routing,
-        :_source,
-        :_source_excludes,
-        :_source_includes
-      ].freeze)
     end
   end
 end