Skip to content

Commit 37db120

Browse files
committed
[API] Updates source code documentation
indices.forcemerge - :wait_for_completion (boolean) Should the request wait until the force merge is completed indices.get - :features (string) Return only information on specified index features (options: aliases, mappings, settings) ml.delete_trained_model (boolean) :force True if the model should be forcefully deleted
1 parent a4a2789 commit 37db120

File tree

4 files changed

+4
-0
lines changed

4 files changed

+4
-0
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ module Actions
2525
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
2626
# @option arguments [String] :routing Specific routing value
2727
# @option arguments [Time] :timeout Explicit operation timeout
28+
# @option arguments [String] :type Default document type for items which don't provide one
2829
# @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
2930
# @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
3031
# @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request

elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ module Actions
2828
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
2929
# @option arguments [Number] :max_num_segments The number of segments the index should be merged into (default: dynamic)
3030
# @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
31+
# @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed.
3132
# @option arguments [Hash] :headers Custom HTTP headers
3233
#
3334
# @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ module Actions
2626
# @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
2727
# @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
2828
# @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
29+
# @option arguments [String] :features Return only information on specified index features (options: aliases, mappings, settings)
2930
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
3031
# @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
3132
# @option arguments [Time] :master_timeout Specify timeout for connection to master

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ module Actions
2323
#
2424
# @option arguments [String] :model_id The ID of the trained model to delete
2525
# @option arguments [Time] :timeout Controls the amount of time to wait for the model to be deleted.
26+
# @option arguments [Boolean] :force True if the model should be forcefully deleted
2627
# @option arguments [Hash] :headers Custom HTTP headers
2728
#
2829
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html

0 commit comments

Comments
 (0)