Skip to content

Commit 8c6876a

Browse files
committed
[API] Updates code display in source code documentation
Use `rake doc` to generate reference docs.
1 parent 93a9a94 commit 8c6876a

File tree

324 files changed

+1813
-1744
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

324 files changed

+1813
-1744
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# Delete an async search.
2626
# If the asynchronous search is still running, it is cancelled.
2727
# Otherwise, the saved search results are deleted.
28-
# If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the +cancel_task+ cluster privilege.
28+
# If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
2929
#
3030
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
3131
# @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module Actions
2828
#
2929
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
3030
# @option arguments [Time] :keep_alive The length of time that the async search should be available in the cluster.
31-
# When not specified, the +keep_alive+ set with the corresponding submit async request will be used.
31+
# When not specified, the `keep_alive` set with the corresponding submit async request will be used.
3232
# Otherwise, it is possible to override the value and extend the validity of the request.
3333
# When this period expires, the search, if still running, is cancelled.
3434
# If the search is completed, its saved results are deleted.

elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
# Get the status of a previously submitted async search request given its identifier, without retrieving search results.
2727
# If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
2828
# * The user or API key that submitted the original async search request.
29-
# * Users that have the +monitor+ cluster privilege or greater privileges.
29+
# * Users that have the `monitor` cluster privilege or greater privileges.
3030
#
3131
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
3232
# @option arguments [Time] :keep_alive The length of time that the async search needs to be available.

elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ module Actions
2626
# When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.
2727
# Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.
2828
# By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
29-
# The maximum allowed size for a stored async search response can be set by changing the +search.max_async_search_response_size+ cluster level setting.
29+
# The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
3030
#
31-
# @option arguments [String, Array] :index A comma-separated list of index names to search; use +_all+ or empty string to perform the operation on all indices
31+
# @option arguments [String, Array] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
3232
# @option arguments [Time] :wait_for_completion_timeout Blocks and waits until the search is completed up to a certain timeout.
3333
# When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. Server default: 1s.
3434
# @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
3535
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
36-
# @option arguments [Boolean] :keep_on_completion If +true+, results are stored for later retrieval when the search completes within the +wait_for_completion_timeout+.
37-
# @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)
36+
# @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
37+
# @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)
3838
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
3939
# @option arguments [String] :analyzer The analyzer to use for the query string
4040
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)

0 commit comments

Comments
 (0)