lib/elasticsearch/api/actions/explain.rb in elasticsearch-api-7.17.11 vs lib/elasticsearch/api/actions/explain.rb in elasticsearch-api-8.0.0.pre1
- old
+ new
@@ -20,11 +20,10 @@
module Actions
# Returns information about why a specific matches (or doesn't match) a query.
#
# @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
@@ -36,63 +35,37 @@
# @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 [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
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html
#
- #
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-explain.html
- #
def explain(arguments = {})
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
headers = arguments.delete(:headers) || {}
+ body = arguments.delete(:body)
+
arguments = arguments.clone
_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)
+ )
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