Skip to content

Commit 228e4c7

Browse files
committed
[API] Updates api docs
1 parent f25ba31 commit 228e4c7

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module Actions
2222
#
2323
# @option arguments [List] :index A comma-separated list of index names to use as default
2424
# @option arguments [List] :type A comma-separated list of document types to use as default
25-
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
25+
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
2626
# @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
2727
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
2828
# @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.

elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module Actions
2222
#
2323
# @option arguments [List] :index A comma-separated list of index names to use as default
2424
# @option arguments [List] :type A comma-separated list of document types to use as default
25-
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
25+
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
2626
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
2727
# @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
2828
# @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module Actions
2929
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
3030
# @option arguments [List] :routing A comma-separated list of specific routing values
3131
# @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
32-
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
32+
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
3333
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
3434
# @option arguments [Boolean] :profile Specify whether to profile the query execution
3535
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/get_user_privileges.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ module XPack
2020
module API
2121
module Security
2222
module Actions
23-
# Retrieves application privileges.
23+
# Retrieves security privileges for the logged in user.
2424
#
2525
# @option arguments [Hash] :headers Custom HTTP headers
2626
#
27-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-privileges.html
27+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-user-privileges.html
2828
#
2929
def get_user_privileges(arguments = {})
3030
headers = arguments.delete(:headers) || {}

0 commit comments

Comments
 (0)