Skip to content

Commit 2a96190

Browse files
committed
[API] Updates source code docs to 49754c484edc5f589ebf4472802475726a8b5abf
1 parent 77ee7c9 commit 2a96190

File tree

520 files changed

+583
-672
lines changed

Some content is hidden

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

520 files changed

+583
-672
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
@@ -34,7 +34,7 @@ module Actions
3434
# returned by Elasticsearch.
3535
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
3636
# For example `"exists_time": "1h"` for humans and
37-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
37+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
3838
# readable values will be omitted. This makes sense for responses being consumed
3939
# only by machines.
4040
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ module Actions
4242
# returned by Elasticsearch.
4343
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4444
# For example `"exists_time": "1h"` for humans and
45-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
45+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
4646
# readable values will be omitted. This makes sense for responses being consumed
4747
# only by machines.
4848
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ module Actions
3737
# returned by Elasticsearch.
3838
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
3939
# For example `"exists_time": "1h"` for humans and
40-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
40+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
4141
# readable values will be omitted. This makes sense for responses being consumed
4242
# only by machines.
4343
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ module Actions
8181
# returned by Elasticsearch.
8282
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
8383
# For example `"exists_time": "1h"` for humans and
84-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
84+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
8585
# readable values will be omitted. This makes sense for responses being consumed
8686
# only by machines.
8787
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ module Actions
109109
# Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.
110110
# The request will only wait for those three shards to refresh.
111111
# The other two shards that make up the index do not participate in the `_bulk` request at all.
112+
# You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.
113+
# Refer to the linked documentation for step-by-step instructions using the index settings API.
112114
#
113115
# @option arguments [String] :index The name of the data stream, index, or index alias to perform bulk actions on.
114116
# @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
@@ -143,7 +145,7 @@ module Actions
143145
# returned by Elasticsearch.
144146
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
145147
# For example `"exists_time": "1h"` for humans and
146-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
148+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
147149
# readable values will be omitted. This makes sense for responses being consumed
148150
# only by machines.
149151
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Actions
4949
# returned by Elasticsearch.
5050
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5151
# For example `"exists_time": "1h"` for humans and
52-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
52+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5353
# readable values will be omitted. This makes sense for responses being consumed
5454
# only by machines.
5555
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ module Actions
4848
# returned by Elasticsearch.
4949
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5050
# For example `"exists_time": "1h"` for humans and
51-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
51+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5252
# readable values will be omitted. This makes sense for responses being consumed
5353
# only by machines.
5454
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ module Actions
5151
# returned by Elasticsearch.
5252
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5353
# For example `"exists_time": "1h"` for humans and
54-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
54+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5555
# readable values will be omitted. This makes sense for responses being consumed
5656
# only by machines.
5757
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ module Actions
4646
# returned by Elasticsearch.
4747
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4848
# For example `"exists_time": "1h"` for humans and
49-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
49+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5050
# readable values will be omitted. This makes sense for responses being consumed
5151
# only by machines.
5252
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ module Actions
4545
# returned by Elasticsearch.
4646
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4747
# For example `"exists_time": "1h"` for humans and
48-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
48+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
4949
# readable values will be omitted. This makes sense for responses being consumed
5050
# only by machines.
5151
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ module Actions
5050
# returned by Elasticsearch.
5151
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5252
# For example `"exists_time": "1h"` for humans and
53-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
53+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5454
# readable values will be omitted. This makes sense for responses being consumed
5555
# only by machines.
5656
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ module Actions
5959
# returned by Elasticsearch.
6060
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
6161
# For example `"exists_time": "1h"` for humans and
62-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
62+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
6363
# readable values will be omitted. This makes sense for responses being consumed
6464
# only by machines.
6565
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ module Actions
4646
# returned by Elasticsearch.
4747
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4848
# For example `"exists_time": "1h"` for humans and
49-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
49+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5050
# readable values will be omitted. This makes sense for responses being consumed
5151
# only by machines.
5252
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ module Actions
4646
# returned by Elasticsearch.
4747
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4848
# For example `"exists_time": "1h"` for humans and
49-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
49+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5050
# readable values will be omitted. This makes sense for responses being consumed
5151
# only by machines.
5252
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ module Actions
5353
# returned by Elasticsearch.
5454
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5555
# For example `"exists_time": "1h"` for humans and
56-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
56+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5757
# readable values will be omitted. This makes sense for responses being consumed
5858
# only by machines.
5959
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ module Actions
5454
# returned by Elasticsearch.
5555
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5656
# For example `"exists_time": "1h"` for humans and
57-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
57+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5858
# readable values will be omitted. This makes sense for responses being consumed
5959
# only by machines.
6060
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Actions
4949
# returned by Elasticsearch.
5050
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5151
# For example `"exists_time": "1h"` for humans and
52-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
52+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5353
# readable values will be omitted. This makes sense for responses being consumed
5454
# only by machines.
5555
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ module Actions
4646
# returned by Elasticsearch.
4747
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4848
# For example `"exists_time": "1h"` for humans and
49-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
49+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5050
# readable values will be omitted. This makes sense for responses being consumed
5151
# only by machines.
5252
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ module Actions
4747
# returned by Elasticsearch.
4848
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4949
# For example `"exists_time": "1h"` for humans and
50-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
50+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5151
# readable values will be omitted. This makes sense for responses being consumed
5252
# only by machines.
5353
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ module Actions
4747
# returned by Elasticsearch.
4848
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4949
# For example `"exists_time": "1h"` for humans and
50-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
50+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5151
# readable values will be omitted. This makes sense for responses being consumed
5252
# only by machines.
5353
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ module Actions
4747
# returned by Elasticsearch.
4848
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4949
# For example `"exists_time": "1h"` for humans and
50-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
50+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5151
# readable values will be omitted. This makes sense for responses being consumed
5252
# only by machines.
5353
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Actions
4949
# returned by Elasticsearch.
5050
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5151
# For example `"exists_time": "1h"` for humans and
52-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
52+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5353
# readable values will be omitted. This makes sense for responses being consumed
5454
# only by machines.
5555
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ module Actions
4646
# returned by Elasticsearch.
4747
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4848
# For example `"exists_time": "1h"` for humans and
49-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
49+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5050
# readable values will be omitted. This makes sense for responses being consumed
5151
# only by machines.
5252
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ module Actions
5151
# returned by Elasticsearch.
5252
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5353
# For example `"exists_time": "1h"` for humans and
54-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
54+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5555
# readable values will be omitted. This makes sense for responses being consumed
5656
# only by machines.
5757
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ module Actions
4848
# returned by Elasticsearch.
4949
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5050
# For example `"exists_time": "1h"` for humans and
51-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
51+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5252
# readable values will be omitted. This makes sense for responses being consumed
5353
# only by machines.
5454
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Actions
4949
# returned by Elasticsearch.
5050
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5151
# For example `"exists_time": "1h"` for humans and
52-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
52+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5353
# readable values will be omitted. This makes sense for responses being consumed
5454
# only by machines.
5555
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ module Actions
5353
# returned by Elasticsearch.
5454
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5555
# For example `"exists_time": "1h"` for humans and
56-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
56+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5757
# readable values will be omitted. This makes sense for responses being consumed
5858
# only by machines.
5959
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Actions
4949
# returned by Elasticsearch.
5050
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5151
# For example `"exists_time": "1h"` for humans and
52-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
52+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5353
# readable values will be omitted. This makes sense for responses being consumed
5454
# only by machines.
5555
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ module Actions
5050
# returned by Elasticsearch.
5151
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5252
# For example `"exists_time": "1h"` for humans and
53-
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
53+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
5454
# readable values will be omitted. This makes sense for responses being consumed
5555
# only by machines.
5656
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use

0 commit comments

Comments
 (0)