diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb index 2b33e06363..8dcad30f4e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :id A unique identifier for the async search. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb index 1aaf945758..1892bb29ca 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb @@ -38,7 +38,7 @@ module Actions # By default no timeout is set meaning that the currently available results will be returned without any additional wait. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb index 3808ce0d1b..52cb332491 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb @@ -33,7 +33,7 @@ module Actions # Ongoing async searches and any saved search results are deleted after this period. Server default: 5d. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb index 4161ecb70d..818e4470cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -74,10 +74,10 @@ module Actions # @option arguments [String] :q Query in the Lucene query string syntax # @option arguments [Integer] :size Number of hits to return (default: 10) # @option arguments [Integer] :from Starting offset (default: 0) - # @option arguments [String] :sort A comma-separated list of : pairs + # @option arguments [String, Array] :sort A comma-separated list of : pairs # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb index aaabbb219c..820ab1844d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb @@ -141,7 +141,7 @@ module Actions # @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created). # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 6ec2a90eac..37549558fa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -45,7 +45,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index 94d7ca4854..8daa241f68 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -44,7 +44,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb index 58db16bcf1..81460d34e8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -47,7 +47,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index 6a1d2d2621..785d772ea6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index 2b92497f34..973b0cf643 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -41,7 +41,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index fdb82bb855..9e66dc9b74 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -46,7 +46,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index edf7703182..edce151313 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -55,7 +55,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index 009b0e1c2a..32d1f3792d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb index f80f568128..128bb733f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb index a8f753d606..0784babd32 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -49,7 +49,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb index 815802bdda..d662ab78e3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -50,7 +50,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb index e9ff2011c2..3bce7e63f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb @@ -45,7 +45,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index 7e11f98af1..7f37d7597c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index 8f02f2ec1d..e2faefd3a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -43,7 +43,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb index d569a4a18f..fd61e80c9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -43,7 +43,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index fa3ab8a147..045dee6b2a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -43,7 +43,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index 0b9c937868..1d2dfafce8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -45,7 +45,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb index 91788ad30c..99166828fb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 6f033294ee..d4aac7e32d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -47,7 +47,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index 15016c69c5..fd96233ec1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -44,7 +44,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 174c5881b2..51296ffab3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -45,7 +45,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index a8dc272c57..94cd3370e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -49,7 +49,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index b4d6078ff6..77b1236f02 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -45,7 +45,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb index 282bc06ae6..505b1c5257 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -46,7 +46,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index fe96fc0240..44f17c0104 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -45,7 +45,7 @@ module Actions # @option arguments [Boolean] :v When set to `true` will enable verbose output. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb index 0e256c15c4..096e3e67b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb @@ -29,7 +29,7 @@ module Actions # IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb index 838cde9637..4adf2ca4c2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb index e431b59ba3..5db8fbd787 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb index 42e67d2f15..4e3c1530bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb @@ -32,7 +32,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb index 9482d4f0f9..a453f076b5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb @@ -34,7 +34,7 @@ module Actions # nodes are still in the cluster. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb index 1eb0811268..90addeb897 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb @@ -34,7 +34,7 @@ module Actions # Defaults to false, which means information is retrieved from the master node. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb index f5178789c8..b1f17237bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb @@ -35,7 +35,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb index 0a82d3da93..079aac89e9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb @@ -33,7 +33,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index f8ae7ce765..f911af0d26 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -45,7 +45,7 @@ module Actions # @option arguments [String] :wait_for_status One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb index d7bbf6c4b7..072af60ec4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String, Array] :target Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb index 3af7d3bfe9..6731138af1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb @@ -34,7 +34,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb index b12d73018a..e74b1b1149 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb @@ -49,7 +49,7 @@ module Actions # is satisfied, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb index 32ff09726a..5b1d9d2ac6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb @@ -47,7 +47,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb index b061c6a702..c9275c67d6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Time] :timeout Explicit operation timeout Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb index bb380caf9f..415e4ff8a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb @@ -28,7 +28,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb index f049292716..9dcc896ba3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index c20dd448b4..04204ffa82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -49,7 +49,7 @@ module Actions # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb index 8ea1fd0371..b6fec0dbf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb @@ -32,7 +32,7 @@ module Actions # However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb index 737be9315a..e12b7f9abc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be checked in (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb index 3efd74cc7c..e4a6acf1ec 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb @@ -37,7 +37,7 @@ module Actions # @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb index 2f03c9e837..5c5c7aa586 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :include_deleted A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb index 7108384ace..17de5d5b15 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb @@ -38,7 +38,7 @@ module Actions # @option arguments [String] :query A wildcard query string that filters connectors with matching name, description or index name # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb index e30afb5065..a5d0286bbd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb @@ -33,7 +33,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb index 8baef6f003..8c522dc97d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be created or updated. ID is auto-generated if not provided. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb index fb44f5e20a..d776a61183 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb index 8d104103f8..923a58500e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be checked in. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb index ffa67e7ee3..24222d17be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb @@ -37,7 +37,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb index a0fb45bced..2210405c5f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be deleted (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb index 4c9475a3cf..5664f49c86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier for the connector sync job. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb index 4a1017e1d9..1982519f18 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb index 127798cf82..aff32bd123 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb @@ -33,10 +33,10 @@ module Actions # @option arguments [Integer] :size Specifies a max number of results to get # @option arguments [String] :status A sync job status to fetch connector sync jobs for # @option arguments [String] :connector_id A connector id to fetch connector sync jobs for - # @option arguments [Syncjobtype] :job_type A comma-separated list of job types to fetch the sync jobs for + # @option arguments [String, Array] :job_type A comma-separated list of job types to fetch the sync jobs for # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb index 62a639d926..d196e1f458 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb @@ -31,7 +31,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb index 76f6af0670..73bb97e6dd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb index 17e7c6d1f3..3d428f9c95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb index f38e502102..271004a680 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb @@ -35,7 +35,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb index c135adf4f1..2906b6cd44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb index b12b213520..125e120bb1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb index 37014f79c0..49909a69e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb @@ -41,7 +41,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb index dadd3ef01c..21b130a3bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb index 07bf9e6596..a5a2263b65 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb index 9e67136797..0140f2c309 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb index d52f4a0567..fdb79d1b95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb index 65496609e1..bfd03a47eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb index a7d4892240..1f53e8e85d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb index 56574b896d..be9be16214 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb index e49161031b..81bc04837e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb index 3e1649c2ad..97d770373a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb index bad74d6604..df7464ea69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb @@ -64,7 +64,7 @@ module Actions # @option arguments [String] :q The query in Lucene query string syntax. This parameter cannot be used with a request body. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index b1a75ee354..ca646bbd7c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -109,7 +109,7 @@ module Actions # The default value of `1` means it waits for each primary shard to be active. Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb index e933afe562..410fca711e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb @@ -31,7 +31,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb index 958efbc0d6..7e554ccacb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb @@ -34,7 +34,7 @@ module Actions # remote Lucene segment files to the follower index. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb index a4a6a7eb9a..ddaa8934a8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb @@ -32,7 +32,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb index cd5e995d2e..48ca0403e8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb @@ -31,7 +31,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb index a40823bf69..8a6671b44a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb @@ -37,7 +37,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb index 8b6792693e..15fb902314 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb @@ -32,7 +32,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb index dbe016ed22..0debf85752 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb @@ -36,7 +36,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb index 4c96049059..19baa9684a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb @@ -34,7 +34,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb index 2defad0e90..b6401a8040 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb index e672554859..2f595c58ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb @@ -33,7 +33,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb index 878237a81f..e277241dbd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb index d70980d6aa..b6143b5716 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb index ba3b05c017..1dab5f7af6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb @@ -33,7 +33,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb index 5e22995e0b..38abcefe22 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb index f05ea7ea86..bbb5ac0e94 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb index 5c137424dc..1a3ae40b31 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb index 73d61c19dd..801f80cca4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb @@ -68,7 +68,7 @@ module Actions # The default value of `1` means it waits for each primary shard to be active. Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb index 5f1025f554..51aaead51c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb @@ -141,7 +141,7 @@ module Actions # If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb index 22308e164d..3fb0e09af5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb @@ -30,7 +30,7 @@ module Actions # To disable throttling, set it to `-1`. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb index e2a6bcfd15..69fad219f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb @@ -33,7 +33,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb index 8d78dc6a68..fbc518c5f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb index 74e0d9a4a2..2b6862309b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks other enrich policy execution requests until complete. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb index f4155deced..e51b92868d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb index fbfaf8a005..3f3dc34aae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb index 31615c5571..c45a6554dd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb index 55a477fc1e..befa7fdbbe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb @@ -31,7 +31,7 @@ module Actions # A search ID is also provided if the request’s `keep_on_completion` parameter is `true`. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb index d00db91d0f..d89b58503c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb @@ -32,7 +32,7 @@ module Actions # Defaults to no timeout, meaning the request waits for complete search results. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb index 69e3cb1d3b..eeaaffe450 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :id Identifier for the search. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 3ff3874324..33772492da 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -38,7 +38,7 @@ module Actions # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb index 8b8b1a589b..950b956e0a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb @@ -35,7 +35,7 @@ module Actions # @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb index 3e3bade27d..be889c993b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb @@ -34,7 +34,7 @@ module Actions # A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb index 0a97f23f8d..7a21c8179b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb @@ -39,7 +39,7 @@ module Actions # Otherwise, the response returns an `is_running` value of `true` and no results. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb index 8df0376f28..051645ad22 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb @@ -33,7 +33,7 @@ module Actions # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb index 2df4117d51..d01d336916 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :id The query ID (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb index 29637890cd..5d083484eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb @@ -31,7 +31,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb index 79352e5921..9e34919f38 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb @@ -36,7 +36,7 @@ module Actions # If `false`, the query will fail if there are any failures.To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb index 37c68ac5a4..e251cd8305 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb @@ -65,7 +65,7 @@ module Actions # @option arguments [String] :version_type The version type. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb index 14d3417dff..302ec4f3dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb @@ -48,7 +48,7 @@ module Actions # @option arguments [String] :version_type The version type. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb index 448211c70a..61f6a0e528 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb @@ -53,7 +53,7 @@ module Actions # @option arguments [String] :q The query in the Lucene query string syntax. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb index 2562e2a5da..591f732697 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb index 97c828e409..b86fe065e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb @@ -41,7 +41,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb index 2af1269b65..e6d4044e75 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Boolean] :include_empty_fields If false, empty fields are not included in the response. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb index ed8366262f..9ae994f9f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb @@ -26,7 +26,7 @@ module Actions # Get the current global checkpoints for an index. # This API is designed for internal use by the Fleet server project. # - # @option arguments [Indexname, Indexalias] :index A single index or index alias that resolves to a single index. (*Required*) + # @option arguments [String] :index A single index or index alias that resolves to a single index. (*Required*) # @option arguments [Boolean] :wait_for_advance A boolean value which controls whether to wait (until the timeout) for the global checkpoints # to advance past the provided `checkpoints`. # @option arguments [Boolean] :wait_for_index A boolean value which controls whether to wait (until the timeout) for the target index to exist @@ -37,7 +37,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a global checkpoints to advance past `checkpoints`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb index 8b2a80e855..d2c6048031 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb @@ -31,7 +31,7 @@ module Actions # to fix any issues, but experimental features are not subject to the # support SLA of official GA features. # - # @option arguments [Indexname, Indexalias] :index A single target to search. If the target is an index alias, it must resolve to a single index. + # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. # @option arguments [Boolean] :ccs_minimize_roundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. @@ -51,7 +51,7 @@ module Actions # Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb index 22978029fa..50a1867f17 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb @@ -30,7 +30,7 @@ module Actions # to fix any issues, but experimental features are not subject to the # support SLA of official GA features. # - # @option arguments [Indexname, Indexalias] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*) + # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*) # @option arguments [Boolean] :allow_no_indices [TODO] # @option arguments [String] :analyzer [TODO] # @option arguments [Boolean] :analyze_wildcard [TODO] @@ -71,7 +71,7 @@ module Actions # @option arguments [String] :q [TODO] # @option arguments [Integer] :size [TODO] # @option arguments [Integer] :from [TODO] - # @option arguments [String] :sort [TODO] + # @option arguments [String, Array] :sort [TODO] # @option arguments [Array] :wait_for_checkpoints A comma separated list of checkpoints. When configured, the search API will only be executed on a shard # after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause # Elasticsearch to immediately execute the search. Server default: []. @@ -80,7 +80,7 @@ module Actions # Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb index 87b8726d98..f56db4357d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb @@ -73,7 +73,7 @@ module Actions # @option arguments [String] :id A unique document identifier. (*Required*) # @option arguments [String] :index The name of the index that contains the document. (*Required*) # @option arguments [Boolean] :force_synthetic_source Indicates whether the request forces synthetic `_source`. - # Use this paramater to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance. + # Use this parameter to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance. # Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index. # @option arguments [String] :preference The node or shard the operation should be performed on. # By default, the operation is randomized between the shard replicas.If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. @@ -95,14 +95,14 @@ module Actions # @option arguments [String, Array] :stored_fields A comma-separated list of stored fields to return as part of a hit. # If no fields are specified, no stored fields are included in the response. # If this field is specified, the `_source` parameter defaults to `false`. - # Only leaf fields can be retrieved with the `stored_field` option. - # Object fields can't be returned;​if specified, the request fails. + # Only leaf fields can be retrieved with the `stored_fields` option. + # Object fields can't be returned; if specified, the request fails. # @option arguments [Integer] :version The version number for concurrency control. # It must match the current version of the document for the request to succeed. # @option arguments [String] :version_type The version type. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb index 7880b7b890..463065bd32 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb @@ -30,7 +30,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: . # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb index fc46bacc9e..c2a3501604 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb index 2070826287..e4853c70b4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index f784ade5d6..09ff866242 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -52,7 +52,7 @@ module Actions # @option arguments [String] :version_type The version type. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb index a01d771ecc..2c130aa113 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb @@ -36,7 +36,7 @@ module Actions # Defaults to no timeout. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb index 17b3ddd293..2744fdb410 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb @@ -35,13 +35,13 @@ module Actions # NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. # When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. # - # @option arguments [String] :feature A feature of the cluster, as returned by the top-level health report API. + # @option arguments [String, Array] :feature A feature of the cluster, as returned by the top-level health report API. # @option arguments [Time] :timeout Explicit operation timeout. # @option arguments [Boolean] :verbose Opt-in for more information about the health of the system. Server default: true. # @option arguments [Integer] :size Limit the number of affected resources the health report API returns. Server default: 1000. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index 1e376a4055..5f9609c74e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -140,7 +140,7 @@ module Actions # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb index 26e3664d96..e2c05a8694 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb index 14b0e8d818..9c2d2fdc2a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb index c629f57923..1deb92bfb4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb index 4c775b2132..9d9e62a866 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb @@ -27,7 +27,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb index 2f960ef46f..50f2934cc4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb @@ -41,7 +41,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb index 26347def2a..a34ff2dad1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb @@ -37,7 +37,7 @@ module Actions # @option arguments [String] :index The name of the index whose lifecycle step is to change (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb index 3762e5ecac..0a81e562a4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb index b92f98d5f7..0ed76c4978 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :index The name of the index to remove policy on (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb index 98cd80fbc9..96c357d670 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb index f06652a092..5d8c009097 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb index 3294353370..fcbf8e3e07 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb index 48f29bdc23..b939d0b306 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb @@ -46,7 +46,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb index 5f6de9d2f8..deccf943ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb @@ -34,7 +34,7 @@ module Actions # If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb index 7eef272ec1..2c7ff6454f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String, Array] :index The index or data stream name (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb index 50c2524ae6..2a7ad38633 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb @@ -36,8 +36,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :fielddata If `true`, clears the fields cache. # Use the `fields` parameter to clear the cache of specific fields only. # @option arguments [String, Array] :fields Comma-separated list of field names used to limit the `fielddata` parameter. @@ -46,7 +45,7 @@ module Actions # @option arguments [Boolean] :request If `true`, clears the request cache. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb index 149fc5bfd5..f1065694ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb @@ -64,7 +64,7 @@ module Actions # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb index dcb3d6a1a7..6171eaed47 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb @@ -42,8 +42,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @@ -53,7 +52,7 @@ module Actions # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb index 84a3a30324..a378aa4dc5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb @@ -56,7 +56,7 @@ module Actions # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb index 1b20fc6c5d..a47d1e476e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb @@ -35,7 +35,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb index 0fa08ccece..07b5ee5f01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :dest The destination index or data stream name (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb index 6b91fdb5f2..161a2c8d4e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb @@ -32,7 +32,7 @@ module Actions # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index b76d32a91d..0e1cf95530 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -37,8 +37,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @@ -46,7 +45,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb index 8a5c63e3e3..2b8b365d38 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb @@ -35,7 +35,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb index 1df0b45a26..cffc680e9f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb index b74ec72f80..4904dd0d4c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. Server default: open. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb index c378548565..ba2851164c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb index eaf5f125a7..905f9314ca 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb index b47f11550a..7d38377dd6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb @@ -33,7 +33,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb index c5ee72bfaf..b6366d19c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb @@ -49,7 +49,7 @@ module Actions # To use the API, this parameter must be set to `true`. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb index 23da0ec8bf..e561c9ff22 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb @@ -38,7 +38,7 @@ module Actions # @option arguments [String] :target_index Name of the index to create. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb index f907b58365..c12bff3209 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb @@ -30,15 +30,14 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response. # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb index 85fce6ab3e..9b104710c4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -32,14 +32,13 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb index 86933e2d4f..f91d25f5a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb index 0461815e48..cb77e46f79 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb @@ -36,7 +36,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb index a1c7098ab2..a8bef26f2c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb index 2da15f1633..74e7b90376 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb @@ -44,7 +44,7 @@ module Actions # @option arguments [String, Array] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb index 8dff2cb008..f3ae1c6245 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb @@ -39,15 +39,14 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :force If `true`, the request forces a flush even if there are no changes to commit to the index. Server default: true. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :wait_if_ongoing If `true`, the flush operation blocks until execution when another flush operation is running. # If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index b903920cbc..794dde22f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -73,7 +73,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb index 40d1a1653d..f5c0280bd0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [String, Array] :features Return only information on specified index features Server default: ['aliases', 'mappings', 'settings']. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb index 5d294fc6f6..364dfe4bc7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -35,14 +35,13 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb index c94e59a18a..aef6cb493b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb @@ -29,13 +29,12 @@ module Actions # Supports wildcards (`*`). # To target all data streams, omit this parameter or use `*` or `_all`. (*Required*) # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb index 0069ad2835..6aa94fd996 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb @@ -27,7 +27,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb index b002e73033..738b8ad189 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :verbose Whether the maximum timestamp for each data stream should be calculated and returned. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb index 8fe6a15de3..255fce00ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb @@ -29,12 +29,11 @@ module Actions # Supports wildcards (`*`). # To target all data streams, omit this parameter or use `*` or `_all`. (*Required*) # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb index b4dcf7a8be..f29ddc494d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb @@ -31,7 +31,7 @@ module Actions # error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb index 1a0561ff72..c3c078595e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb @@ -36,13 +36,12 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb index 12199f932a..22902d7795 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb index 98b8588917..2df24093b4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb @@ -32,15 +32,14 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb index ec60ca60d3..92c3be8db1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String, Array] :index The index or data stream name. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb index 8ded9b502c..848f894a66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb @@ -48,7 +48,7 @@ module Actions # error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb index 90cd5744cf..5c20f20f77 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb @@ -35,7 +35,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb index 0c0f7f7372..5ba5dc5b9d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb @@ -33,7 +33,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb index 4e99d47e32..db5e43af83 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb @@ -39,7 +39,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb index d04ad36ae5..5fdf7b2c10 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb @@ -27,7 +27,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index a37675655c..8f81debf9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -49,8 +49,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @@ -60,7 +59,7 @@ module Actions # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb index d24e5ad28d..7aaea86b36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb @@ -36,7 +36,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb index 34ec0c4a68..c7fa157d29 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb @@ -37,7 +37,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb index 7b955cb282..3dfc9774ca 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb @@ -29,8 +29,7 @@ module Actions # Supports wildcards (`*`). # To target all data streams use `*` or `_all`. (*Required*) # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `hidden`, `open`, `closed`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is # received before the timeout expires, the request fails and returns an # error. Server default: 30s. @@ -38,7 +37,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb index 1f702043f6..7d882463f2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb @@ -29,8 +29,7 @@ module Actions # Supports wildcards (`*`). # To target all data streams use `*` or `_all`. (*Required*) # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `hidden`, `open`, `closed`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is # received before the timeout expires, the request fails and returns an # error. Server default: 30s. @@ -38,7 +37,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb index a8cf8b01a2..a5957e5ed5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb @@ -39,7 +39,7 @@ module Actions # timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb index 136d83d7bc..25ebdc2976 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb @@ -51,7 +51,7 @@ module Actions # @option arguments [String] :cause User defined reason for creating/updating the index template # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb index 61119acf87..7642a06665 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb @@ -39,8 +39,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @@ -49,7 +48,7 @@ module Actions # @option arguments [Boolean] :write_index_only If `true`, the mappings are applied only to the current write index for the target. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb index ad924412f7..b1314880d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb @@ -103,7 +103,7 @@ module Actions # timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb index 805e8aa713..cb1559c019 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb @@ -48,7 +48,7 @@ module Actions # @option arguments [String] :cause User defined reason for creating/updating the index template # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index 106c4a0e7c..c48704617d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -47,7 +47,7 @@ module Actions # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb index 94dc7a4718..64263c2079 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb @@ -40,12 +40,11 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb index e12cb6fc05..86667f0a8e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb @@ -41,7 +41,7 @@ module Actions # @option arguments [String] :resource Changed resource to reload analyzers from if applicable # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb index dc54f464b9..fd97fa0a16 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb @@ -63,7 +63,6 @@ module Actions # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index # options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: open. # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen. @@ -80,7 +79,7 @@ module Actions # not responding (typically 30 seconds). # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb index b58d64e272..6271513ca0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb @@ -30,15 +30,14 @@ module Actions # Resources on remote clusters can be specified using the ``:`` syntax. (*Required*) # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. # This behavior applies even if the request targets other open indices. # For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb index 7f438686c2..eb3bce0f61 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb @@ -64,7 +64,7 @@ module Actions # Only allowed on data streams. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb index 0d8198b0ae..142a4a5958 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb @@ -33,12 +33,11 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb index 40f700a4da..45af11df39 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb @@ -39,10 +39,10 @@ module Actions # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, # this argument determines whether wildcard expressions match hidden data streams. Server default: open. # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. - # @option arguments [Shardstorestatus] :status List of shard health statuses used to limit the request. + # @option arguments [String, Array] :status List of shard health statuses used to limit the request. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb index 595eda2cd1..4689b7f7bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb @@ -56,7 +56,7 @@ module Actions # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb index 5df1c36a9f..915ba5e90f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb index e361ce7350..6bd7956886 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb index 6c2c9887a4..86b0ad3e02 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb @@ -59,7 +59,7 @@ module Actions # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index 4fcc4a1ed6..35d02d9f16 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -40,13 +40,13 @@ module Actions # @option arguments [String, Array] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics. # @option arguments [String, Array] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. # @option arguments [Boolean] :forbid_closed_indices If true, statistics are not collected from closed indices. Server default: true. - # @option arguments [String] :groups Comma-separated list of search groups to include in the search statistics. + # @option arguments [String, Array] :groups Comma-separated list of search groups to include in the search statistics. # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory. # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb index aff6e12438..2b87ac4040 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb @@ -31,7 +31,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb index b1d85ab952..d9637d9a65 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb @@ -39,8 +39,7 @@ module Actions # This parameter can only be used when the `q` query string parameter is specified. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :explain If `true`, the response returns detailed information if an error has occurred. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. @@ -48,7 +47,7 @@ module Actions # @option arguments [String] :q Query in the Lucene query string syntax. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb index e4980baa0c..a9c571695b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb index 93a5a87d48..0475c49ab6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb index 28a81ca53b..f12cd80917 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :force When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb index a9b44f9db7..5c522fda3a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :inference_id The inference Id # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb index 2c9afa7db8..8b0aa2ebc2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb index 1307842b65..15809dde8a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb @@ -48,7 +48,7 @@ module Actions # @option arguments [String] :inference_id The inference Id (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb index c37c061e1d..e43c65e847 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :alibabacloud_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb index 6b2640e77d..9df1782073 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :amazonbedrock_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb index 2d55914f39..57a86731d4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :anthropic_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb index cbe46c1e87..d3019a61a7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :azureaistudio_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb index 1f091278b7..d18f4ca42c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [String] :azureopenai_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb index 23949bff76..b9fecbf0ee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :cohere_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb index 26240fded2..aecaa6eadd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb @@ -30,7 +30,7 @@ module Actions # The must not match the `model_id`. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb index 361d331829..0cdfd11e04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :elser_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb index 6f117edb27..94c1931f20 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :googleaistudio_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb index 091f28c2a2..c182992c39 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :googlevertexai_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb index c74562e5f6..e2b259c920 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb @@ -57,7 +57,7 @@ module Actions # @option arguments [String] :huggingface_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb index 167d1a4bed..ee58f69b6f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :jinaai_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb index edf03f503c..efe1d161a7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :mistral_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb index 017212abc8..1939bbb541 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :openai_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb index 2470834a63..c12f39cbc6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :voyageai_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb index afc57b60e6..9d9d0b530b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :watsonx_inference_id The unique identifier of the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb index 15ea31e157..b462a30dd1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb index f743b57375..dd823864e3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb index ade4d46679..81494f1f52 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb index 40e8f0f7c0..7a81cca33c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb index d23e189f2d..34935ee9aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :task_type The type of inference task that the model performs. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb index 7e60ff9b8e..7f27d816e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb index 6f8ae19796..99455b98e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb index 2d57be7cf0..082c57dd99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb @@ -33,7 +33,7 @@ module Actions # A value of `-1` indicates that the request should never time out. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb index bdaf5ab13c..6189dccb8c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb @@ -33,7 +33,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb index b63f6a4556..fd4780e893 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb @@ -27,7 +27,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb index 081f85821c..5dd2c5efa7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb @@ -30,7 +30,7 @@ module Actions # To get all database configurations, omit this parameter or use `*`. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb index e62cd93b22..76efbcc081 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb @@ -32,7 +32,7 @@ module Actions # A value of `-1` indicates that the request should never time out. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb index 517a3b1e3d..091d6edfd8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb index b260ec0c7c..06e0d1a66e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb index affcd931d2..717dd0cc2a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb index de1035057f..e06e074a3d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb @@ -33,7 +33,7 @@ module Actions # A value of `-1` indicates that the request should never time out. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb index 445aaed1fe..1131e12633 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb index 012cc1f37a..619c618920 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :verbose If `true`, the response includes output data for each processor in the executed pipeline. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb index b4e4346749..e6b12ce163 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb index 5a06c33d0f..64f3a6aa43 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :local Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb index 36db70e696..724c34fe43 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb index 5db4226ade..95d929f46e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb index 7658b21e76..170f3aa240 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb @@ -35,7 +35,7 @@ module Actions # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb index 07447105dc..7f4a1d4255 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb index 83ea19a544..bd4a8cd7dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb index f281ee6dec..75bc324db8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :id An identifier for the pipeline. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb index 35f863330c..39808a3927 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String, Array] :id A comma-separated list of pipeline identifiers. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb index bb70432e2d..25011a6237 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :id An identifier for the pipeline. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb index f2542a7f0b..295afc9f05 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb index b4171dde51..5e28698f6a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb @@ -36,7 +36,7 @@ module Actions # @option arguments [Time] :timeout Controls the time to wait until a job has closed. Server default: 30m. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb index a57b9740fb..c580d64e9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb index 0384a04da2..e689cf6664 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb @@ -29,7 +29,7 @@ module Actions # You can obtain this identifier by using the get calendar events API. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb index 6fd87f744c..551b04397a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb @@ -29,7 +29,7 @@ module Actions # comma-separated list of jobs or groups. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb index 2093990c90..0af2679240 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :timeout The time to wait for the job to be deleted. Server default: 1m. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb index 8f676219ee..68cbb28918 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb @@ -32,7 +32,7 @@ module Actions # stopping and deleting the datafeed. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb index f65eb0b42f..8d7ae72bf4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb @@ -39,7 +39,7 @@ module Actions # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled. Server default: 8h. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb index e0a241b83a..e8f6c73457 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb index 201df511b1..c9d21cf584 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb @@ -41,7 +41,7 @@ module Actions # error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb index 60beebe906..16f009a99e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb @@ -40,7 +40,7 @@ module Actions # job deletion completes. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb index c351aff05d..48bb7172a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb index 971f5ee53a..cef7cebe93 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb index f59fc15bff..c4089208c1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :model_id The trained model ID to which the model alias refers. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb index 2b0e0a0814..a2d749afa8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb index ca394320c7..ca3fd17a8c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb @@ -30,7 +30,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb index 406ceb63bb..25ba1b8901 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb @@ -35,7 +35,7 @@ module Actions # underscores. It must start and end with alphanumeric characters. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb index 71f46c5efd..d1c05511b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb @@ -45,7 +45,7 @@ module Actions # buckets on which to calculate interim results. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb index ab8c3ae04d..86514d91e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb @@ -43,7 +43,7 @@ module Actions # amount. Server default: 20mb. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb index 3ac843b04d..9168ffb6b4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb @@ -41,7 +41,7 @@ module Actions # and results are not limited to specific timestamps. Server default: -1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb index 79dc829e1a..84f21c20ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String, Time] :start Specifies to get events with timestamps after this time. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb index c7ace27021..a9b97b3c41 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Integer] :size Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. Server default: 10000. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb index 7eb0d1c29a..154da74930 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb @@ -35,7 +35,7 @@ module Actions # @option arguments [Integer] :size Specifies the maximum number of categories to obtain. Server default: 100. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb index 94e0e13f78..d514453e4f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb @@ -46,7 +46,7 @@ module Actions # be retrieved and then added to another cluster. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb index b2f3b5ec9d..52b29b618b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb @@ -41,7 +41,7 @@ module Actions # @option arguments [Boolean] :verbose Defines whether the stats response should be verbose. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb index d7732edfda..0cb9d5ee47 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb @@ -43,7 +43,7 @@ module Actions # `404` status code when there are no matches or only partial matches. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb index e51e552546..f7549e542a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb @@ -45,7 +45,7 @@ module Actions # be retrieved and then added to another cluster. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb index decb9e99bb..14b6f960b6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Integer] :size Specifies the maximum number of filters to obtain. Server default: 100. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb index e7f1f1e479..91b9e23b68 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb @@ -44,7 +44,7 @@ module Actions # means it is unset and results are not limited to specific timestamps. Server default: -1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb index c33000ef4a..452a6788de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb @@ -38,7 +38,7 @@ module Actions # code when there are no matches or only partial matches. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb index de74fb7671..c36c3b7a9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb @@ -44,7 +44,7 @@ module Actions # be retrieved and then added to another cluster. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb index c70d55d038..61d90a2ab0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb @@ -34,7 +34,7 @@ module Actions # fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb index 77be544bec..2eb49c8e4f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb @@ -37,7 +37,7 @@ module Actions # no matches or only partial matches. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb index 5c5eda5c80..25ee58380f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb @@ -37,7 +37,7 @@ module Actions # @option arguments [String, Time] :start Returns snapshots with timestamps after this time. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb index b7a9ab407f..61179d2cde 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb @@ -59,14 +59,14 @@ module Actions # the optional `bucket_span` parameter. # @option arguments [String, Time] :end Returns overall buckets with timestamps earlier than this time. # @option arguments [Boolean] :exclude_interim If `true`, the output excludes interim results. - # @option arguments [Double, String] :overall_score Returns overall buckets with overall scores greater than or equal to this + # @option arguments [Float, String] :overall_score Returns overall buckets with overall scores greater than or equal to this # value. # @option arguments [String, Time] :start Returns overall buckets with timestamps after this time. # @option arguments [Integer] :top_n The number of top anomaly detection job bucket scores to be used in the # `overall_score` calculation. Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb index 67f099f9df..ad69302684 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb @@ -47,7 +47,7 @@ module Actions # results are not limited to specific timestamps. Server default: -1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb index 8cadb29d4b..a4ad541bdc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb @@ -42,12 +42,12 @@ module Actions # @option arguments [String] :include A comma delimited string of optional fields to include in the response # body. # @option arguments [Integer] :size Specifies the maximum number of models to obtain. Server default: 100. - # @option arguments [String] :tags A comma delimited string of tags. A trained model can have many tags, or + # @option arguments [String, Array] :tags A comma delimited string of tags. A trained model can have many tags, or # none. When supplied, only trained models that contain all the supplied # tags are returned. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb index f10eca2425..8ce767a4e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb @@ -38,7 +38,7 @@ module Actions # @option arguments [Integer] :size Specifies the maximum number of models to obtain. Server default: 100. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb index 9a1de98005..74b4015948 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. Server default: 10s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb index 5eaf4d829c..ed6a9917cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb @@ -33,7 +33,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb index 226969c050..76e33a9e38 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Time] :timeout Controls the time to wait until a job has opened. Server default: 30m. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb index 33af245e3a..d9d80054d0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb index 439fd739dd..cd083ff46b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String, Time] :reset_start Specifies the start of the bucket resetting range. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb index eac3f60f61..24be8d4c48 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :id Identifier for the data frame analytics job. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb index 3b001a2635..dd3d6ba032 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb @@ -40,7 +40,7 @@ module Actions # @option arguments [String, Time] :end The end time when the datafeed preview should stop # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb index 0be00026d2..0e9d38dad2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb index 3b399d9bc5..6956a888fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String, Array] :job_id An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb index 18aee24aa4..13aac0bffa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb @@ -34,7 +34,7 @@ module Actions # underscores. It must start and end with alphanumeric characters. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb index 5d8809d19b..faa7deae86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb @@ -53,7 +53,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable If true, unavailable indices (missing or closed) are ignored. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb index 4eb0f47a2f..8fb704b6ad 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb index 202f9ec629..ee216f78f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb @@ -30,17 +30,12 @@ module Actions # @option arguments [Boolean] :allow_no_indices If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the # `_all` string or when no indices are specified. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines - # whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: - # - `all`: Match any data stream or index, including hidden ones. - # - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - # - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both. - # - `none`: Wildcard patterns are not accepted. - # - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. Server default: open. + # whether wildcard expressions match hidden data streams. Supports comma-separated values. Server default: open. # @option arguments [Boolean] :ignore_throttled If `true`, concrete, expanded or aliased indices are ignored when frozen. Server default: true. # @option arguments [Boolean] :ignore_unavailable If `true`, unavailable indices (missing or closed) are ignored. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb index ca612e0ec3..fbad56ab44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb @@ -33,7 +33,7 @@ module Actions # to complete. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb index eacfbefeca..20a23679ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb @@ -47,7 +47,7 @@ module Actions # already assigned and this parameter is false, the API returns an error. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb index 8880120d1a..2e98e89f1c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb @@ -29,7 +29,7 @@ module Actions # order of their part number. The first part must be `0` and the final part must be `total_parts - 1`. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb index 3b7a2e7fee..cf3314b7e4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb index 9a74d6fc12..36725095c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb @@ -36,7 +36,7 @@ module Actions # reset. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb index 1baecf5469..53ac06188f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb @@ -43,7 +43,7 @@ module Actions # data, then delete the intervening results. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb index d5fc44bf1e..6b6c81997c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Time] :timeout The time to wait for the request to be completed. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb index 66e44a93d6..7a27049de5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb @@ -42,7 +42,7 @@ module Actions # starts. Server default: 20s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb index 44b96426b5..65895120b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb @@ -53,7 +53,7 @@ module Actions # @option arguments [Time] :timeout Specifies the amount of time to wait until a datafeed starts. Server default: 20s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb index b9883902ed..bf3f0e2844 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb @@ -49,7 +49,7 @@ module Actions # @option arguments [String] :wait_for Specifies the allocation status to wait for before returning. Server default: started. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb index de284db4ed..45c05110a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb @@ -43,7 +43,7 @@ module Actions # stops. Defaults to 20 seconds. Server default: 20s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb index 7c38f32304..89c224e2f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb @@ -40,7 +40,7 @@ module Actions # @option arguments [Time] :timeout Specifies the amount of time to wait until a datafeed stops. Server default: 20s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb index 71845be9d6..51e84b9a46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb @@ -33,7 +33,7 @@ module Actions # restart the model deployment. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb index 4373bfaf26..d912a15130 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb @@ -29,7 +29,7 @@ module Actions # underscores. It must start and end with alphanumeric characters. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb index 167dd5fba1..7667ea7751 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb @@ -34,17 +34,12 @@ module Actions # @option arguments [Boolean] :allow_no_indices If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the # `_all` string or when no indices are specified. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines - # whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: - # - `all`: Match any data stream or index, including hidden ones. - # - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - # - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both. - # - `none`: Wildcard patterns are not accepted. - # - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. Server default: open. + # whether wildcard expressions match hidden data streams. Supports comma-separated values. Server default: open. # @option arguments [Boolean] :ignore_throttled If `true`, concrete, expanded or aliased indices are ignored when frozen. Server default: true. # @option arguments [Boolean] :ignore_unavailable If `true`, unavailable indices (missing or closed) are ignored. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb index 770baeb2e0..910c929531 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb index 3bee8d1242..a68b0c6461 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :job_id Identifier for the job. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb index 5aa6f67398..b8cbe10e3e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb index 7305d3e49a..1bfbd7a7e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb @@ -33,7 +33,7 @@ module Actions # it will automatically be changed to a value less than the number of hardware threads. Server default: 1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb index adfef5923b..556d152d5f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb @@ -40,7 +40,7 @@ module Actions # @option arguments [Time] :timeout Controls the time to wait for the request to complete. Server default: 30m. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb index 6c67cee351..e5fb188906 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb @@ -51,7 +51,7 @@ module Actions # @option arguments [String, Array] :stored_fields If `true`, retrieves the document fields stored in the index rather than the document `_source`. Server default: false. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb index c8b672aff5..8e2b19c9f2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :index Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb index 40508c60a1..48ac42b7b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb @@ -30,7 +30,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb index 7a9fe02428..5cf6b87593 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb @@ -30,7 +30,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index 1322d2bea4..79046ffc59 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -63,7 +63,7 @@ module Actions # @option arguments [Boolean] :typed_keys Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb index 8db01e7489..49d19c067c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb @@ -46,7 +46,7 @@ module Actions # @option arguments [Boolean] :typed_keys If `true`, the response prefixes aggregation and suggester names with their respective types. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb index 3cbb6ff335..e55ab8dc7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb @@ -48,7 +48,7 @@ module Actions # @option arguments [String] :version_type The version type. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb index e55848929b..0b41dbc5fb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Integer] :max_archive_version Specifies the maximum `archive_version` to be cleared from the archive. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb index 2bfb3ac00f..37d412db5e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb index ab223ee9fc..79f9b2948b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb @@ -38,7 +38,7 @@ module Actions # @option arguments [String] :sort The sort order for 'cpu' type (default: total) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb index 39797ecb5b..9015a48a34 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb index f39746abc3..1546de45d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb @@ -35,7 +35,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb index eba840da4b..0a3f9f79c2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb @@ -40,7 +40,7 @@ module Actions # @option arguments [Boolean] :include_unloaded_segments If `true`, the response includes information from segments that are not loaded into memory. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb index 9665a484f6..68c8837633 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb @@ -31,7 +31,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb index a208aacc5b..e2e6489db6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb @@ -56,14 +56,14 @@ module Actions # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # It supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # It supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :allow_partial_search_results Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. # If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. # If `true`, the point in time will contain all the shards that are available at the time of the request. # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb index 3a28ad4d87..0716ab5d95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb index 2ef6237ef9..b10754ef0b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb @@ -36,7 +36,7 @@ module Actions # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb index e5cb20b22e..5ac265e874 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to delete (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb index 2a409f74e4..bdf6b9d08e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb index 54cd5d7942..0aa68f1edb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to retrieve (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb index edcadb9579..ab6d145e89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :ruleset_id The unique identifier of the query ruleset (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb index 0a8573ccd2..f316a47ecb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Integer] :size The maximum number of results to retrieve. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb index 82a0734a59..13bd300f86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to be created or updated. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb index cd0186487f..7eaa48b5ab 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to be created or updated. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb index 67303824f5..14401f38a3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to be created or updated (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index 17e7461112..eeec317a6d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :search_type Search operation type # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index 256f70859d..8da7e90752 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -72,7 +72,7 @@ module Actions # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb index 306e037f4d..dc45aa8df9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb @@ -38,7 +38,7 @@ module Actions # It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb index 236315a430..9892557a15 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb @@ -28,7 +28,7 @@ module Actions # If no `source` is specified, this or the `id` request body parameter is required. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb index c5f4caedb4..e23ff0246c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb @@ -34,7 +34,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb index 9f5d972756..2f92c9b944 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb @@ -37,7 +37,7 @@ module Actions # @option arguments [Boolean] :rest_total_hits_as_int If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index d6c6adf31b..a1f2a03374 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -143,13 +143,13 @@ module Actions # @option arguments [Integer] :from The starting document offset, which must be non-negative. # By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. # To page through more hits, use the `search_after` parameter. Server default: 0. - # @option arguments [String] :sort A comma-separated list of `:` pairs. + # @option arguments [String, Array] :sort A comma-separated list of `:` pairs. # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? # Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. # Fetches with this enabled will be slower the enabling synthetic source natively in the index. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb index 13f3088669..368195c5c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :name The name of the search application to delete. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb index 6ef11c5dea..fff6f169f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :name The name of the analytics collection to be deleted (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb index e738bdd9a4..d6cff61401 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :name The name of the search application (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb index 660b6de9ac..94a264d918 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Array] :name A list of analytics collections to limit the returned information # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb index 6f897752f4..535e2ec659 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Integer] :size Specifies a max number of results to get. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb index d2ee109814..6d009064d2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :debug Whether the response type has to include more details # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb index d1f269eb2d..076fd7ddff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :create If `true`, this request cannot replace or update existing Search Applications. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb index a17b7e33f7..bb78b327f8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :name The name of the analytics collection to be created or updated. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb index 5ec97ac066..97825b6d04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb @@ -35,7 +35,7 @@ module Actions # @option arguments [String] :name The name of the search application to render teh query for. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb index 37051e5128..23d3df75ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb index 905a48c762..71cfb8c988 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb @@ -174,7 +174,7 @@ module Actions # In addition, the new features will be distinguishable using the tag `_mvt_label_position`. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb index 3efe11308b..7e4b6bf50e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb @@ -35,8 +35,7 @@ module Actions # For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. @@ -47,7 +46,7 @@ module Actions # @option arguments [String] :routing A custom value used to route operations to a specific shard. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index 81af1f8d8c..57bf0477d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -32,7 +32,6 @@ module Actions # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. # Supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. # @option arguments [Boolean] :explain If `true`, the response includes additional details about score computation as part of a hit. # @option arguments [Boolean] :ignore_throttled If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. Server default: true. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. @@ -48,7 +47,7 @@ module Actions # @option arguments [Boolean] :typed_keys If `true`, the response prefixes aggregation and suggester names with their respective types. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb index ff5f8c45e6..09591389a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :master_timeout [TODO] # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb index f786618ae6..45ddcad6bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb @@ -36,7 +36,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb index 2481abc6ea..6e33d83a89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :storage The mount option for the searchable snapshot index. Server default: full_copy. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb index 12e093886d..4d0585d8a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :level Return stats aggregated at cluster, index or shard level # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb index 97e7e354ea..f879eb08bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb index 8cb8c29d25..2b966ba783 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb @@ -30,7 +30,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb index c47ed254ed..8681072c11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb index f3cdcc310d..32d1fba696 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb index 434ede18bc..dba78ec574 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb index 2aa2584e7f..6627fe3161 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb index a50887c0d2..de9a70492a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb @@ -31,7 +31,7 @@ module Actions # Does not support other wildcard patterns. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb index 5998fd3570..91d0d8fc81 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb @@ -31,7 +31,7 @@ module Actions # It does not support other wildcard patterns. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb index 8c17fc6acc..54b0029de3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb @@ -36,7 +36,7 @@ module Actions # If you do not specify this parameter, the API evicts all users from the user cache. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb index f1934a1b38..93d270c008 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb @@ -30,7 +30,7 @@ module Actions # It does not support other wildcard patterns. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb index 666969aedd..8e120b9ea6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb @@ -36,7 +36,7 @@ module Actions # It does not support other wildcard patterns. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb index fbb380eda1..054d393a58 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb @@ -35,7 +35,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb index b19db3add2..b108c084b8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb index 91f666fe23..2cc69047d6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb index 9727db832b..3568c02052 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb @@ -33,7 +33,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb index 1116f23fdf..de02b6ef84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb index 3081cc30bf..55b48ce615 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb index e0dc29b181..8f9ed70d5a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb index 2d29100320..2d595f53b7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb index 1f63fb15b3..386ec7d8c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb index 8f72687516..93091175d9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb index 859bfe7cff..2eb070ad87 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb @@ -36,7 +36,7 @@ module Actions # If 'false', it does nothing with refreshes. Server default: false. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb index 52e49bd9fa..9024a2c4fd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb index 4164b3ee63..2ebf5988f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb @@ -37,7 +37,7 @@ module Actions # If 'false', nothing is done with refreshes. Server default: false. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb index 4506e9bacc..4612eef79c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb index 2901465576..77b4a91407 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb index bdd1b89ff7..9074be47b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb @@ -46,7 +46,7 @@ module Actions # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb index 77661caa44..113b42ac51 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb @@ -27,7 +27,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb index 1f325c750f..ec1a9abbe7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb @@ -34,7 +34,7 @@ module Actions # If you do not specify this parameter, the API returns information about all privileges for the requested application. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb index 8144e93f78..7fd509ff02 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb @@ -32,7 +32,7 @@ module Actions # If you do not specify this parameter, the API returns information about all roles. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb index eb8c457cee..c620a837d3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String, Array] :name The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb index daf2d69f77..fd35bb6ece 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb @@ -33,7 +33,7 @@ module Actions # Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb index e279de488f..6b708fb469 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :service The service name. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb index f5e7b37e0c..f96f9f45bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb @@ -33,7 +33,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb index c434c3c957..b6552bd949 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb index 5b465fc763..bc1fd3ae3a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb @@ -25,11 +25,11 @@ module Actions # Get users. # Get information about users in the native realm and built-in users. # - # @option arguments [Username] :username An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users. + # @option arguments [String, Array] :username An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users. # @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb index ce4dcd5b30..c060231760 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb @@ -30,10 +30,10 @@ module Actions # # @option arguments [String] :application The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. # @option arguments [String] :priviledge The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. - # @option arguments [Name, Null] :username [TODO] + # @option arguments [String, nil] :username [TODO] # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb index eb3de0a496..7ced47d809 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb @@ -28,14 +28,14 @@ module Actions # Individual users and external applications should not call this API directly. # Elastic reserves the right to change or remove this feature in future releases without prior notice. # - # @option arguments [Userprofileid] :uid A unique identifier for the user profile. (*Required*) - # @option arguments [String] :data A comma-separated list of filters for the `data` field of the profile document. + # @option arguments [String, Array] :uid A unique identifier for the user profile. (*Required*) + # @option arguments [String, Array] :data A comma-separated list of filters for the `data` field of the profile document. # To return all content use `data=*`. # To return a subset of content use `data=` to retrieve content nested under the specified ``. # By default returns no `data` content. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb index 4a4105cb84..043dbc4611 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb @@ -41,7 +41,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb index b41ca80039..5280960338 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :user Username # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb index e7e117ae9a..6f3e964d9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb index 888acf19f3..9a65eb425e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb @@ -36,7 +36,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb index 09cdc2bb28..92e8a2a5fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb index adf8c3adb3..1faf9fa780 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb index 961e218491..81e0143361 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb @@ -30,7 +30,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb index ea255a274e..626fc6477b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb @@ -30,7 +30,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb index 4193e623fb..c371f2f1fb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb @@ -39,7 +39,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb index 03ca99a270..ea419afee9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb index f8a63ce8c2..766061b0a7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb @@ -46,7 +46,7 @@ module Actions # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb index 91f1973567..838b0badb2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb @@ -34,7 +34,7 @@ module Actions # These values have the same meaning as in the index API, but the default value for this API is true. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb index 5b803d2f9a..507bf7eecd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb @@ -37,7 +37,7 @@ module Actions # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb index a472ad2694..5139b1897d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb @@ -31,7 +31,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb index a154c7f36c..113a347d96 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb index a2f8bb8e62..e5425c8863 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb index e13bc1f4f7..61b05d625c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb @@ -34,7 +34,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb index d191ec5e80..d15f3411a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb @@ -33,7 +33,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb index f162dc22e4..8206409fe6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb @@ -31,7 +31,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb index 04ee9a312c..c21d7ff22d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb @@ -36,7 +36,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb index c710c8d52a..bc1726ea7c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :realm_name The name of the SAML realm in Elasticsearch. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb index 3379bcd899..cb732b0706 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb @@ -28,14 +28,14 @@ module Actions # Individual users and external applications should not call this API directly. # Elastic reserves the right to change or remove this feature in future releases without prior notice. # - # @option arguments [String] :data A comma-separated list of filters for the `data` field of the profile document. + # @option arguments [String, Array] :data A comma-separated list of filters for the `data` field of the profile document. # To return all content use `data=*`. # To return a subset of content, use `data=` to retrieve content nested under the specified ``. # By default, the API returns no `data` content. # It is an error to specify `data` as both the query parameter and the request body field. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb index 01b4081fa0..134d29b2c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb @@ -40,7 +40,7 @@ module Actions # @option arguments [String] :id The ID of the API key to update. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb index 2d343e734a..40b33161e6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb @@ -33,11 +33,12 @@ module Actions # This API supports updates to an API key's access scope, metadata, and expiration. # The owner user's information, such as the `username` and `realm`, is also updated automatically on every call. # NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API. + # To learn more about how to use this API, refer to the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples Update cross cluter API key API examples page}. # # @option arguments [String] :id The ID of the cross-cluster API key to update. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb index 462d9b75b4..00aa13e0af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb @@ -34,7 +34,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb index f24056708b..7a311efdf6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb @@ -44,7 +44,7 @@ module Actions # If 'false', nothing is done with refreshes. Server default: false. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb index 3d5ffeb5e5..87eb3dd92a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb @@ -47,7 +47,7 @@ module Actions # This value can be used to override the default pipeline of the index. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb index ebd56f3800..2b0473601b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb @@ -34,7 +34,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb index b19e0b86b1..dff9d4a6ed 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb @@ -33,7 +33,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb index b157504525..3ae48024c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb @@ -35,7 +35,7 @@ module Actions # If `false`, the request returns a response when the snapshot initializes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb index 5c72edf39c..6b4cf5b5c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb @@ -41,7 +41,7 @@ module Actions # You can also perform this verification with the verify snapshot repository API. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb index bfe86c7913..bed7ed95ee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb @@ -32,7 +32,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb index 135b732a8d..dde6b82724 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb @@ -36,7 +36,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb index 5372d55da8..ea014a13d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb @@ -56,10 +56,12 @@ module Actions # To include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy. # @option arguments [String] :sort The sort order for the result. # The default behavior is sorting by snapshot start time stamp. Server default: start_time. + # @option arguments [String, Array, Array] :state Only return snapshots with a state found in the given comma-separated list of snapshot states. + # The default is all snapshot states. # @option arguments [Boolean] :verbose If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb index 0069aa204b..9f89cd8ab7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb @@ -33,7 +33,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: to 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb index a195eb40c3..7baa2bb380 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb @@ -130,7 +130,7 @@ module Actions # If no response is received before the timeout expires, the test is cancelled and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb index 053781e1e9..742679a82f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb @@ -69,7 +69,7 @@ module Actions # If this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb index 27c4826b04..87e559750a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb @@ -47,7 +47,7 @@ module Actions # This applies even if one or more of the recovery attempts fail.If `false`, the request returns a response when the restore operation initializes. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb index 7ec18acb2a..5011d182d2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb @@ -47,7 +47,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb index a736e83cfd..39d967521e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb @@ -34,7 +34,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb index f627ba1f14..2b7b8aaaa2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb @@ -33,7 +33,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb index 7854c98bf9..d4106e21b4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb @@ -33,7 +33,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb index 59e5782ce0..00ef9c7dea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb @@ -32,7 +32,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb index 54721d045f..f4fe1889f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb @@ -32,7 +32,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb index 39793b5f75..5e231f3da6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb index da2ac20cbb..3756f78055 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb @@ -32,7 +32,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb index de782a1785..8ebac084b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb @@ -36,7 +36,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb index 6ae4a09c34..ca4887e6a7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb @@ -34,7 +34,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb index e9bce506ad..edd75d23e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb @@ -38,7 +38,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb index cff266ef79..f173964cd2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb index 99cd626757..0c42219a69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :id The identifier for the search. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb index 13a0b1b6e2..70be7ab0e4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb @@ -38,7 +38,7 @@ module Actions # It defaults to no timeout, meaning the request waits for complete search results. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb index 20c49a7494..3d5a3d9d3d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :id The identifier for the search. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb index 4700876511..c0ea16581e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb @@ -30,7 +30,7 @@ module Actions # If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb index 700cff0c13..ebb5a64017 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb @@ -28,7 +28,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb index 07a0fae13d..183510740e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb @@ -36,7 +36,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb index 52a6681f17..210c05143a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb @@ -39,7 +39,7 @@ module Actions # @option arguments [String] :id The synonyms set identifier to delete. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb index c1e6e090d4..2d321fd9e4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb @@ -31,7 +31,7 @@ module Actions # If `false`, analyzers will not be reloaded with the deleted synonym rule Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb index 1df42029a0..2343d7766f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Integer] :size The max number of query rules to retrieve. Server default: 10. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb index 1287d32e36..b28efc445b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :rule_id The ID of the synonym rule to retrieve. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb index 56c15ef4f1..beb5189131 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Integer] :size The maximum number of synonyms sets to retrieve. Server default: 10. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb index 869864c917..37359216c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb @@ -33,7 +33,7 @@ module Actions # If `false`, analyzers will not be reloaded with the new synonym set Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb index 5ef74e8001..dd2d156954 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb @@ -33,7 +33,7 @@ module Actions # If `false`, analyzers will not be reloaded with the new synonym rule Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb index 466456aaa9..68916f8cf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb @@ -37,13 +37,13 @@ module Actions # support SLA of official GA features. # # @option arguments [String] :task_id The task identifier. - # @option arguments [String] :actions A comma-separated list or wildcard expression of actions that is used to limit the request. + # @option arguments [String, Array] :actions A comma-separated list or wildcard expression of actions that is used to limit the request. # @option arguments [Array] :nodes A comma-separated list of node IDs or names that is used to limit the request. # @option arguments [String] :parent_task_id A parent task ID that is used to limit the tasks. # @option arguments [Boolean] :wait_for_completion If true, the request blocks until all found tasks are complete. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb index 1890c87c75..70c1d854b6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb @@ -38,7 +38,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb index c05ee1191c..6982390b25 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb @@ -83,7 +83,7 @@ module Actions # to fix any issues, but experimental features are not subject to the # support SLA of official GA features. # - # @option arguments [String] :actions A comma-separated list or wildcard expression of actions used to limit the request. + # @option arguments [String, Array] :actions A comma-separated list or wildcard expression of actions used to limit the request. # For example, you can use `cluser:*` to retrieve all cluster-related tasks. # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about the running tasks. # This information is useful to distinguish tasks from each other but is more costly to run. @@ -99,7 +99,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb index 91ca01aec1..1720c9b04c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb @@ -30,7 +30,7 @@ module Actions # To search all data streams or indices, omit this parameter or use `*` or `_all`. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb index d6970b02c7..b2f8049b09 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb @@ -67,7 +67,7 @@ module Actions # @option arguments [String] :version_type The version type. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb index 6e2a7700e9..5b2bde035b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb @@ -103,7 +103,7 @@ module Actions # When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb index 30347b35b0..e618577e92 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb @@ -99,7 +99,7 @@ module Actions # When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb index bf2d6c0764..64df1b3eba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb @@ -31,7 +31,7 @@ module Actions # Valid values are `disabled` and `v1`. Server default: disabled. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb index 905dc3bc40..f43e22b8a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb index 9db94e4843..5615e61c04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb @@ -42,7 +42,7 @@ module Actions # be retrieved and then added to another cluster. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb index cacd29fdfb..2009ab3c6b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb @@ -40,7 +40,7 @@ module Actions # @option arguments [Time] :timeout Controls the time to wait for the stats # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb index 4c2896d14e..0862ea63f8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb @@ -34,7 +34,7 @@ module Actions # timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb index 19ce231a1b..543b8a04ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb @@ -51,7 +51,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb index 3b12cbba0f..befbce52d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb index 1bac032d07..0b1154da13 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb index d652d721ed..f8745d04d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb index 7e25ae3905..00ac01c74b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb @@ -41,7 +41,7 @@ module Actions # immediately and the indexer is stopped asynchronously in the background. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb index d0987e47b8..7c332e6505 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb @@ -38,7 +38,7 @@ module Actions # timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb index df0c406f39..7beff33e4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb @@ -40,7 +40,7 @@ module Actions # returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index cfb6d75f28..fadd2e549a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -60,7 +60,7 @@ module Actions # @option arguments [String, Array] :_source_includes The source fields you want to retrieve. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb index f1cd3bb886..b706ce947c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -102,7 +102,6 @@ module Actions # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. # It supports comma-separated values, such as `open,hidden`. - # Valid values are: `all`, `open`, `closed`, `hidden`, `none`. # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. @@ -151,7 +150,7 @@ module Actions # Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb index 2129ee3eed..3fecbde8af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb @@ -30,7 +30,7 @@ module Actions # To turn off throttling, set it to `-1`. Server default: -1. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb index 7496a4b11d..0a288fee2a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb @@ -29,13 +29,14 @@ module Actions # The reason for this behavior is to prevent overwriting the watch status from a watch execution. # Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. # This happens when the condition of the watch is not met (the condition evaluates to false). + # To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation. # # @option arguments [String] :watch_id The watch identifier. (*Required*) # @option arguments [String, Array] :action_id A comma-separated list of the action identifiers to acknowledge. # If you omit this parameter, all of the actions of the watch are acknowledged. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb index 77c0b50354..8d544e0931 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :watch_id The watch identifier. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb index e1523f898a..194f579e90 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :watch_id The watch identifier. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb index ef60364a18..de316b5404 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :id The watch identifier. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb index e24ec04e36..4a41b653aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb @@ -32,12 +32,13 @@ module Actions # When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. # If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch. # When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. + # Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches. # # @option arguments [String] :id The watch identifier. # @option arguments [Boolean] :debug Defines whether the watch runs in debug mode. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb index 17f236c6fb..ea4c5cc226 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb @@ -30,7 +30,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb index aeac8fdd70..3f94364a91 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :id The watch identifier. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb index 2b32f7f3ec..c252173e11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb @@ -40,7 +40,7 @@ module Actions # @option arguments [Integer] :version Explicit version number for concurrency control # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb index 87bab4c0c8..eba3e8072b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb @@ -28,7 +28,7 @@ module Actions # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb index 5aefad5984..e2a06b0a9f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb index d59a1925ba..35b0f08295 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb @@ -26,11 +26,11 @@ module Actions # This API always returns basic metrics. # You retrieve more metrics by using the metric parameter. # - # @option arguments [Watchermetric] :metric Defines which additional metrics are included in the response. + # @option arguments [String, Array] :metric Defines which additional metrics are included in the response. # @option arguments [Boolean] :emit_stacktraces Defines whether stack traces are generated for each watch that is running. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb index 964ad69639..9e90e11b10 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb @@ -30,7 +30,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb index 540f1e717d..61b36289e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb @@ -36,7 +36,7 @@ module Actions # If no response is received before the timeout expires, the request fails and returns an error. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb index 3518c0c832..347e18cc0b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb @@ -35,7 +35,7 @@ module Actions # In particular, it adds descriptions and a tag line. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb index 37296732f1..d15f5bcd4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb @@ -31,7 +31,7 @@ module Actions # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. - # @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response # returned by Elasticsearch. # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. # For example `"exists_time": "1h"` for humans and diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index 5f366afd0e..ce4ac60bd6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -18,6 +18,6 @@ module Elasticsearch module API VERSION = '9.0.0'.freeze - ES_SPECIFICATION_COMMIT = '49754c484edc5f589ebf4472802475726a8b5abf'.freeze + ES_SPECIFICATION_COMMIT = '09ebf27a057301e6f26581259d3c1d105074bdfd'.freeze end end