Skip to content

Commit 486b545

Browse files
committed
[XPACK] Updates a few endpoints documentations and removes type from graph.explore
1 parent 7ed9a61 commit 486b545

File tree

4 files changed

+4
-16
lines changed

4 files changed

+4
-16
lines changed

Diff for: elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/submit.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ module Actions
5858
# @option arguments [String] :suggest_text The source text for which the suggestions should be returned
5959
# @option arguments [Time] :timeout Explicit operation timeout
6060
# @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
61-
# @option arguments [Boolean] :track_total_hits Indicate if the number of documents that match the query should be tracked
61+
# @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.
6262
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
6363
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
6464
# @option arguments [Boolean] :version Specify whether to return document version as part of a hit

Diff for: elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/graph/explore.rb

+1-13
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,11 @@ module Actions
2323
# Explore extracted and summarized information about the documents and terms in an index.
2424
#
2525
# @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
26-
# @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types *Deprecated*
2726
# @option arguments [String] :routing Specific routing value
2827
# @option arguments [Time] :timeout Explicit operation timeout
2928
# @option arguments [Hash] :headers Custom HTTP headers
3029
# @option arguments [Hash] :body Graph Query DSL
3130
#
32-
# *Deprecation notice*:
33-
# Specifying types in urls has been deprecated
34-
# Deprecated since version 7.0.0
35-
#
36-
#
3731
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/graph-explore-api.html
3832
#
3933
def explore(arguments = {})
@@ -45,19 +39,13 @@ def explore(arguments = {})
4539

4640
_index = arguments.delete(:index)
4741

48-
_type = arguments.delete(:type)
49-
5042
method = if arguments[:body]
5143
Elasticsearch::API::HTTP_POST
5244
else
5345
Elasticsearch::API::HTTP_GET
5446
end
5547

56-
path = if _index && _type
57-
"#{Elasticsearch::API::Utils.__listify(_index)}/#{Elasticsearch::API::Utils.__listify(_type)}/_graph/explore"
58-
else
59-
"#{Elasticsearch::API::Utils.__listify(_index)}/_graph/explore"
60-
end
48+
path = "#{Elasticsearch::API::Utils.__listify(_index)}/_graph/explore"
6149
params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
6250

6351
body = arguments[:body]

Diff for: elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/info.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module Actions
2222
# Retrieves information about the installed X-Pack features.
2323
#
2424
# @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features
25-
# @option arguments [Boolean] :accept_enterprise If an enterprise license is installed, return the type and mode as 'enterprise' (default: false)
25+
# @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated*
2626
# @option arguments [Hash] :headers Custom HTTP headers
2727
#
2828
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/info-api.html

Diff for: elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/license/get.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module Actions
2323
# Retrieves licensing information for the cluster
2424
#
2525
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
26-
# @option arguments [Boolean] :accept_enterprise If the active license is an enterprise license, return type as 'enterprise' (default: false)
26+
# @option arguments [Boolean] :accept_enterprise Supported for backwards compatibility with 7.x. If this param is used it must be set to true *Deprecated*
2727
# @option arguments [Hash] :headers Custom HTTP headers
2828
#
2929
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-license.html

0 commit comments

Comments
 (0)