From 59ff4e6123c47f56f979bb4b775f2c9e8cbf002e Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Mon, 24 Nov 2025 06:04:20 +0000 Subject: [PATCH] Auto-generated API code --- .../api/actions/async_search/submit.rb | 2 +- .../lib/elasticsearch/api/actions/bulk.rb | 2 +- .../elasticsearch/api/actions/cat/aliases.rb | 4 ++-- .../api/actions/cat/allocation.rb | 2 +- .../api/actions/cat/component_templates.rb | 2 +- .../elasticsearch/api/actions/cat/count.rb | 2 +- .../api/actions/cat/fielddata.rb | 2 +- .../elasticsearch/api/actions/cat/health.rb | 2 +- .../elasticsearch/api/actions/cat/indices.rb | 6 +++--- .../elasticsearch/api/actions/cat/master.rb | 2 +- .../actions/cat/ml_data_frame_analytics.rb | 4 ++-- .../api/actions/cat/ml_datafeeds.rb | 4 ++-- .../elasticsearch/api/actions/cat/ml_jobs.rb | 4 ++-- .../api/actions/cat/ml_trained_models.rb | 4 ++-- .../api/actions/cat/nodeattrs.rb | 2 +- .../elasticsearch/api/actions/cat/nodes.rb | 2 +- .../api/actions/cat/pending_tasks.rb | 2 +- .../elasticsearch/api/actions/cat/plugins.rb | 2 +- .../elasticsearch/api/actions/cat/recovery.rb | 2 +- .../elasticsearch/api/actions/cat/segments.rb | 4 ++-- .../elasticsearch/api/actions/cat/shards.rb | 2 +- .../api/actions/cat/snapshots.rb | 2 +- .../elasticsearch/api/actions/cat/tasks.rb | 2 +- .../api/actions/cat/templates.rb | 2 +- .../api/actions/cat/thread_pool.rb | 2 +- .../api/actions/cat/transforms.rb | 4 ++-- .../actions/cluster/get_component_template.rb | 2 +- .../api/actions/cluster/health.rb | 4 ++-- .../api/actions/cluster/reroute.rb | 2 +- .../api/actions/cluster/state.rb | 4 ++-- .../api/actions/connector/sync_job_list.rb | 2 +- .../lib/elasticsearch/api/actions/count.rb | 4 ++-- .../lib/elasticsearch/api/actions/create.rb | 2 +- .../lib/elasticsearch/api/actions/delete.rb | 2 +- .../api/actions/delete_by_query.rb | 4 ++-- .../elasticsearch/api/actions/eql/search.rb | 2 +- .../lib/elasticsearch/api/actions/exists.rb | 2 +- .../api/actions/exists_source.rb | 2 +- .../lib/elasticsearch/api/actions/explain.rb | 2 +- .../elasticsearch/api/actions/field_caps.rb | 2 +- .../lib/elasticsearch/api/actions/get.rb | 2 +- .../elasticsearch/api/actions/get_source.rb | 2 +- .../api/actions/graph/explore.rb | 2 +- .../lib/elasticsearch/api/actions/index.rb | 2 +- .../api/actions/indices/add_block.rb | 4 ++-- .../api/actions/indices/clear_cache.rb | 2 +- .../api/actions/indices/close.rb | 2 +- .../api/actions/indices/delete.rb | 2 +- .../actions/indices/delete_data_lifecycle.rb | 2 +- .../api/actions/indices/delete_data_stream.rb | 2 +- .../indices/delete_data_stream_options.rb | 2 +- .../api/actions/indices/disk_usage.rb | 2 +- .../api/actions/indices/exists.rb | 2 +- .../api/actions/indices/exists_alias.rb | 2 +- .../api/actions/indices/field_usage_stats.rb | 2 +- .../api/actions/indices/flush.rb | 2 +- .../api/actions/indices/forcemerge.rb | 2 +- .../elasticsearch/api/actions/indices/get.rb | 4 ++-- .../api/actions/indices/get_alias.rb | 2 +- .../api/actions/indices/get_data_lifecycle.rb | 2 +- .../api/actions/indices/get_data_stream.rb | 2 +- .../indices/get_data_stream_options.rb | 2 +- .../api/actions/indices/get_field_mapping.rb | 2 +- .../api/actions/indices/get_mapping.rb | 2 +- .../api/actions/indices/get_settings.rb | 2 +- .../elasticsearch/api/actions/indices/open.rb | 2 +- .../api/actions/indices/put_data_lifecycle.rb | 2 +- .../indices/put_data_stream_options.rb | 2 +- .../api/actions/indices/put_mapping.rb | 2 +- .../api/actions/indices/put_settings.rb | 2 +- .../api/actions/indices/recovery.rb | 2 +- .../api/actions/indices/refresh.rb | 2 +- .../indices/reload_search_analyzers.rb | 2 +- .../api/actions/indices/resolve_cluster.rb | 4 ++-- .../api/actions/indices/resolve_index.rb | 2 +- .../api/actions/indices/segments.rb | 2 +- .../api/actions/indices/shard_stores.rb | 2 +- .../api/actions/indices/stats.rb | 4 ++-- .../api/actions/indices/unfreeze.rb | 4 ++-- .../api/actions/indices/validate_query.rb | 2 +- .../api/actions/inference/delete.rb | 2 +- .../api/actions/inference/get.rb | 2 +- .../api/actions/inference/inference.rb | 2 +- .../api/actions/inference/put.rb | 2 +- .../api/actions/inference/put_alibabacloud.rb | 2 +- .../actions/inference/put_amazonbedrock.rb | 2 +- .../actions/inference/put_amazonsagemaker.rb | 2 +- .../api/actions/inference/put_anthropic.rb | 2 +- .../actions/inference/put_azureaistudio.rb | 2 +- .../api/actions/inference/put_azureopenai.rb | 2 +- .../api/actions/inference/put_cohere.rb | 2 +- .../api/actions/inference/put_custom.rb | 2 +- .../api/actions/inference/put_deepseek.rb | 2 +- .../actions/inference/put_elasticsearch.rb | 2 +- .../api/actions/inference/put_elser.rb | 2 +- .../actions/inference/put_googleaistudio.rb | 2 +- .../actions/inference/put_googlevertexai.rb | 2 +- .../api/actions/inference/put_hugging_face.rb | 2 +- .../api/actions/inference/put_jinaai.rb | 2 +- .../api/actions/inference/put_mistral.rb | 2 +- .../api/actions/inference/put_openai.rb | 2 +- .../api/actions/inference/put_voyageai.rb | 2 +- .../api/actions/inference/put_watsonx.rb | 2 +- .../api/actions/inference/update.rb | 2 +- .../actions/machine_learning/put_datafeed.rb | 4 ++-- .../api/actions/machine_learning/put_job.rb | 4 ++-- .../machine_learning/update_datafeed.rb | 4 ++-- .../lib/elasticsearch/api/actions/mget.rb | 2 +- .../api/actions/monitoring/bulk.rb | 21 ++----------------- .../lib/elasticsearch/api/actions/msearch.rb | 2 +- .../elasticsearch/api/actions/mtermvectors.rb | 2 +- .../api/actions/nodes/hot_threads.rb | 4 ++-- .../elasticsearch/api/actions/nodes/info.rb | 2 +- .../elasticsearch/api/actions/nodes/stats.rb | 4 ++-- .../elasticsearch/api/actions/nodes/usage.rb | 2 +- .../api/actions/open_point_in_time.rb | 4 ++-- .../elasticsearch/api/actions/rank_eval.rb | 2 +- .../lib/elasticsearch/api/actions/search.rb | 4 ++-- .../post_behavioral_analytics_event.rb | 2 +- .../api/actions/search_shards.rb | 4 ++-- .../api/actions/search_template.rb | 4 ++-- .../searchable_snapshots/clear_cache.rb | 2 +- .../elasticsearch/api/actions/termvectors.rb | 2 +- .../lib/elasticsearch/api/actions/update.rb | 2 +- .../api/actions/update_by_query.rb | 2 +- 125 files changed, 153 insertions(+), 170 deletions(-) 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 718be6c2d..adf39f78b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -42,7 +42,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb index 0cdfdfc51..2a84ce1cb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb @@ -26,7 +26,7 @@ module Actions # @option arguments [String] :index Default index for items which don't provide one # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 0e1443d9d..b3ad86c4f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -27,11 +27,11 @@ module Actions # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: alias, index, filter, routing.index, routing.search, is_write_index) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index 5c4397a44..70d0b2a48 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: shards, shards.undesired, write_load.forecast, disk.indices.forecast, disk.indices, disk.used, disk.avail, disk.total, disk.percent, host, ip, node, node.role) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers 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 3a4962323..27f8b6a81 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: name, version, alias_count, mapping_count, settings_count, metadata_count, included_in) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index fa6a1a394..548f7e646 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -26,7 +26,7 @@ module Actions # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: epoch, timestamp, count) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index 1d98f94e8..355225d90 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: id, host, ip, node, field, size) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index a4e2fc05f..ef20b568a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -25,7 +25,7 @@ module Actions # Get the cluster health status # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: epoch, timestamp, cluster, status, node.total, node.data, shards, pri, relo, init, unassign, unassign.pri, pending_tasks, max_task_wait_time, active_shards_percent) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index 6826a215f..6104b8100 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -28,15 +28,15 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red) + # @option arguments [List] :h Comma-separated list of column names to display (options: health, status, index, uuid, pri, rep, docs.count, docs.deleted, creation.date, creation.date.string, store.size, pri.store.size, dataset.size, completion.size, pri.completion.size, fielddata.memory_size, pri.fielddata.memory_size, fielddata.evictions, pri.fielddata.evictions, query_cache.memory_size, pri.query_cache.memory_size, query_cache.evictions, pri.query_cache.evictions, request_cache.memory_size, pri.request_cache.memory_size, request_cache.evictions, pri.request_cache.evictions, request_cache.hit_count, pri.request_cache.hit_count, request_cache.miss_count, pri.request_cache.miss_count, flush.total, pri.flush.total, flush.total_time, pri.flush.total_time, get.current, pri.get.current, get.time, pri.get.time, get.total, pri.get.total, get.exists_time, pri.get.exists_time, get.exists_total, pri.get.exists_total, get.missing_time, pri.get.missing_time, get.missing_total, pri.get.missing_total, indexing.delete_current, pri.indexing.delete_current, indexing.delete_time, pri.indexing.delete_time, indexing.delete_total, pri.indexing.delete_total, indexing.index_current, pri.indexing.index_current, indexing.index_time, pri.indexing.index_time, indexing.index_total, pri.indexing.index_total, indexing.index_failed, pri.indexing.index_failed, indexing.index_failed_due_to_version_conflict, pri.indexing.index_failed_due_to_version_conflict, merges.current, pri.merges.current, merges.current_docs, pri.merges.current_docs, merges.current_size, pri.merges.current_size, merges.total, pri.merges.total, merges.total_docs, pri.merges.total_docs, merges.total_size, pri.merges.total_size, merges.total_time, pri.merges.total_time, refresh.total, pri.refresh.total, refresh.time, pri.refresh.time, refresh.external_total, pri.refresh.external_total, refresh.external_time, pri.refresh.external_time, refresh.listeners, pri.refresh.listeners, search.fetch_current, pri.search.fetch_current, search.fetch_time, pri.search.fetch_time, search.fetch_total, pri.search.fetch_total, search.open_contexts, pri.search.open_contexts, search.query_current, pri.search.query_current, search.query_time, pri.search.query_time, search.query_total, pri.search.query_total, search.scroll_current, pri.search.scroll_current, search.scroll_time, pri.search.scroll_time, search.scroll_total, pri.search.scroll_total, segments.count, pri.segments.count, segments.memory, pri.segments.memory, segments.index_writer_memory, pri.segments.index_writer_memory, segments.version_map_memory, pri.segments.version_map_memory, segments.fixed_bitset_memory, pri.segments.fixed_bitset_memory, warmer.current, pri.warmer.current, warmer.total, pri.warmer.total, warmer.total_time, pri.warmer.total_time, suggest.current, pri.suggest.current, suggest.time, pri.suggest.time, suggest.total, pri.suggest.total, memory.total, pri.memory.total, bulk.total_operations, pri.bulk.total_operations, bulk.total_time, pri.bulk.total_time, bulk.total_size_in_bytes, pri.bulk.total_size_in_bytes, bulk.avg_time, pri.bulk.avg_time, bulk.avg_size_in_bytes, pri.bulk.avg_size_in_bytes, dense_vector.value_count, pri.dense_vector.value_count, sparse_vector.value_count, pri.sparse_vector.value_count) + # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red, unknown, unavailable) # @option arguments [Boolean] :help Return help information # @option arguments [Boolean] :pri Set to true to return stats only for primary shards # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-indices.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index e5242cbe1..f9f2a3174 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: id, host, ip, node) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers 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 eefa12efa..d47ab1d86 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 @@ -28,9 +28,9 @@ module Actions # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: assignment_explanation, create_time, description, dest_index, failure_reason, id, model_memory_limit, node.address, node.ephemeral_id, node.id, node.name, progress, source_index, state, type, version) # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by + # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by (options: assignment_explanation, create_time, description, dest_index, failure_reason, id, model_memory_limit, node.address, node.ephemeral_id, node.id, node.name, progress, source_index, state, type, version) # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers 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 7db400a71..e943a350c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -27,9 +27,9 @@ module Actions # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: ae, bc, id, na, ne, ni, nn, sba, sc, seah, st, s) # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by + # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by (options: ae, bc, id, na, ne, ni, nn, sba, sc, seah, st, s) # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) 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 00723cf7e..fef2e481e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -28,9 +28,9 @@ module Actions # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: assignment_explanation, buckets.count, buckets.time.exp_avg, buckets.time.exp_avg_hour, buckets.time.max, buckets.time.min, buckets.time.total, data.buckets, data.earliest_record, data.empty_buckets, data.input_bytes, data.input_fields, data.input_records, data.invalid_dates, data.last, data.last_empty_bucket, data.last_sparse_bucket, data.latest_record, data.missing_fields, data.out_of_order_timestamps, data.processed_fields, data.processed_records, data.sparse_buckets, forecasts.memory.avg, forecasts.memory.max, forecasts.memory.min, forecasts.memory.total, forecasts.records.avg, forecasts.records.max, forecasts.records.min, forecasts.records.total, forecasts.time.avg, forecasts.time.max, forecasts.time.min, forecasts.time.total, forecasts.total, id, model.bucket_allocation_failures, model.by_fields, model.bytes, model.bytes_exceeded, model.categorization_status, model.categorized_doc_count, model.dead_category_count, model.failed_category_count, model.frequent_category_count, model.log_time, model.memory_limit, model.memory_status, model.over_fields, model.partition_fields, model.rare_category_count, model.timestamp, model.total_category_count, node.address, node.ephemeral_id, node.id, node.name, opened_time, state) # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by + # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by (options: assignment_explanation, buckets.count, buckets.time.exp_avg, buckets.time.exp_avg_hour, buckets.time.max, buckets.time.min, buckets.time.total, data.buckets, data.earliest_record, data.empty_buckets, data.input_bytes, data.input_fields, data.input_records, data.invalid_dates, data.last, data.last_empty_bucket, data.last_sparse_bucket, data.latest_record, data.missing_fields, data.out_of_order_timestamps, data.processed_fields, data.processed_records, data.sparse_buckets, forecasts.memory.avg, forecasts.memory.max, forecasts.memory.min, forecasts.memory.total, forecasts.records.avg, forecasts.records.max, forecasts.records.min, forecasts.records.total, forecasts.time.avg, forecasts.time.max, forecasts.time.min, forecasts.time.total, forecasts.total, id, model.bucket_allocation_failures, model.by_fields, model.bytes, model.bytes_exceeded, model.categorization_status, model.categorized_doc_count, model.dead_category_count, model.failed_category_count, model.frequent_category_count, model.log_time, model.memory_limit, model.memory_status, model.over_fields, model.partition_fields, model.rare_category_count, model.timestamp, model.total_category_count, node.address, node.ephemeral_id, node.id, node.name, opened_time, state) # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers 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 6ba80368d..71c7668a1 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 @@ -30,9 +30,9 @@ module Actions # @option arguments [Integer] :size specifies a max number of trained models to get # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: create_time, created_by, data_frame_analytics_id, description, heap_size, id, ingest.count, ingest.current, ingest.failed, ingest.pipelines, ingest.time, license, operations, version) # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by + # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by (options: create_time, created_by, data_frame_analytics_id, description, heap_size, id, ingest.count, ingest.current, ingest.failed, ingest.pipelines, ingest.time, license, operations, version) # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index 6fc865f36..f6e8e065d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: node, id, pid, host, ip, port, attr, value) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index 61c506715..1cb07fc41 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: build, completion.size, cpu, disk.avail, disk.total, disk.used, disk.used_percent, fielddata.evictions, fielddata.memory_size, file_desc.current, file_desc.max, file_desc.percent, flush.total, flush.total_time, get.current, get.exists_time, get.exists_total, get.missing_time, get.missing_total, get.time, get.total, heap.current, heap.max, heap.percent, http_address, id, indexing.delete_current, indexing.delete_time, indexing.delete_total, indexing.index_current, indexing.index_failed, indexing.index_failed_due_to_version_conflict, indexing.index_time, indexing.index_total, ip, jdk, load_1m, load_5m, load_15m, available_processors, mappings.total_count, mappings.total_estimated_overhead_in_bytes, master, merges.current, merges.current_docs, merges.current_size, merges.total, merges.total_docs, merges.total_size, merges.total_time, name, node.role, pid, port, query_cache.memory_size, query_cache.evictions, query_cache.hit_count, query_cache.miss_count, ram.current, ram.max, ram.percent, refresh.total, refresh.time, request_cache.memory_size, request_cache.evictions, request_cache.hit_count, request_cache.miss_count, script.compilations, script.cache_evictions, search.fetch_current, search.fetch_time, search.fetch_total, search.open_contexts, search.query_current, search.query_time, search.query_total, search.scroll_current, search.scroll_time, search.scroll_total, segments.count, segments.fixed_bitset_memory, segments.index_writer_memory, segments.memory, segments.version_map_memory, shard_stats.total_count, suggest.current, suggest.time, suggest.total, uptime, version) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) 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 4d8ee9fac..158cadbd5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: insertOrder, timeInQueue, priority, source) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index 3935cbc33..60865edcf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: id, name, component, version, description) # @option arguments [Boolean] :help Return help information # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index 6f7d6afe8..05790b8bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: index, shard, start_time, start_time_millis, stop_time, stop_time_millis, time, type, stage, source_host, source_node, target_host, target_node, repository, snapshot, files, files_recovered, files_percent, files_total, bytes, bytes_recovered, bytes_percent, bytes_total, translog_ops, translog_ops_recovered, translog_ops_percent) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 0479357f9..da1b481c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: index, shard, prirep, ip, segment, generation, docs.count, docs.deleted, size, size.memory, committed, searchable, version, compound, id) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers @@ -37,7 +37,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression. # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression. # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). Only allowed when providing an index expression. - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :allow_closed If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index 9c1012b15..51cc4a6a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: completion.size, dataset.size, dense_vector.value_count, docs, fielddata.evictions, fielddata.memory_size, flush.total, flush.total_time, get.current, get.exists_time, get.exists_total, get.missing_time, get.missing_total, get.time, get.total, id, index, indexing.delete_current, indexing.delete_time, indexing.delete_total, indexing.index_current, indexing.index_failed_due_to_version_conflict, indexing.index_failed, indexing.index_time, indexing.index_total, ip, merges.current, merges.current_docs, merges.current_size, merges.total, merges.total_docs, merges.total_size, merges.total_time, node, prirep, query_cache.evictions, query_cache.memory_size, recoverysource.type, refresh.time, refresh.total, search.fetch_current, search.fetch_time, search.fetch_total, search.open_contexts, search.query_current, search.query_time, search.query_total, search.scroll_current, search.scroll_time, search.scroll_total, segments.count, segments.fixed_bitset_memory, segments.index_writer_memory, segments.memory, segments.version_map_memory, seq_no.global_checkpoint, seq_no.local_checkpoint, seq_no.max, shard, dsparse_vector.value_count, state, store, suggest.current, suggest.time, suggest.total, sync_id, unassigned.at, unassigned.details, unassigned.for, unassigned.reason) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 649418bf2..f7335eeb1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: id, repository, status, start_epoch, start_time, end_epoch, end_time, duration, indices, successful_shards, failed_shards, total_shards, reason) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index 4b563fbb3..9fc6acaa3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all. # @option arguments [Boolean] :detailed Return detailed task information (default: false) # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: id, action, task_id, parent_task_id, type, start_time, timestamp, running_time_ns, running_time, node_id, ip, port, node, version, x_opaque_id) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index af0e842b8..83eef6c85 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: name, index_patterns, order, version, composed_of) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers 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 5089909fe..389ad64f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: active, completed, core, ephemeral_id, host, ip, keep_alive, largest, max, name, node_id, node_name, pid, pool_size, port, queue, queue_size, rejected, size, type) # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index dd1c80fa9..6b52d982a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -29,9 +29,9 @@ module Actions # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100 # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display + # @option arguments [List] :h Comma-separated list of column names to display (options: changes_last_detection_time, checkpoint, checkpoint_duration_time_exp_avg, checkpoint_progress, create_time, delete_time, description, dest_index, documents_deleted, documents_indexed, docs_per_second, documents_processed, frequency, id, index_failure, index_time, index_total, indexed_documents_exp_avg, last_search_time, max_page_search_size, pages_processed, pipeline, processed_documents_exp_avg, processing_time, reason, search_failure, search_time, search_total, source_index, state, transform_type, trigger_count, version) # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by + # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by (options: changes_last_detection_time, checkpoint, checkpoint_duration_time_exp_avg, checkpoint_progress, create_time, delete_time, description, dest_index, documents_deleted, documents_indexed, docs_per_second, documents_processed, frequency, id, index_failure, index_time, index_total, indexed_documents_exp_avg, last_search_time, max_page_search_size, pages_processed, pipeline, processed_documents_exp_avg, processing_time, reason, search_failure, search_time, search_total, source_index, state, transform_type, trigger_count, version) # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) 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 32c25e5e9..261de5328 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 @@ -24,7 +24,7 @@ module Cluster module Actions # Get component templates # - # @option arguments [List] :name The comma separated names of the component templates + # @option arguments [String] :name The name of the component template. Wildcard (`*`) expressions are supported. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index 1cc104481..6397778fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -25,7 +25,7 @@ module Actions # Get the cluster health status # # @option arguments [List] :index Limit the information returned to a specific index - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :level Specify the level of detail for returned information (options: cluster, indices, shards) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -35,7 +35,7 @@ module Actions # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid) # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster - # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red) + # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red, unknown, unavailable) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-health.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb index 38ef242d6..382f33eb0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many subsequent allocation failures - # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata (options: _all, blocks, metadata, nodes, none, routing_table, master_node, version) + # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata *Deprecated* # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index 0dd1a8a23..a5b02a3ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -24,7 +24,7 @@ module Cluster module Actions # Get the cluster state # - # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version) + # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, customs, metadata, nodes, routing_table, routing_nodes, master_node, version) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Specify timeout for connection to master @@ -33,7 +33,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] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-state.html 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 f365d713a..325831f7e 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 @@ -32,7 +32,7 @@ module Actions # @option arguments [Integer] :size specifies a max number of results to get (default: 100) # @option arguments [String] :status A sync job status to fetch connector sync jobs for (options: canceling, canceled, completed, error, in_progress, pending, suspended) # @option arguments [String] :connector_id Id of the connector to fetch the sync jobs for - # @option arguments [List] :job_type A comma-separated list of job types + # @option arguments [List] :job_type A comma-separated list of job types (options: full, incremental, access_control) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-connector-sync-jobs-api.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb index 87d72bb1c..22549bdb6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb @@ -25,9 +25,9 @@ module Actions # # @option arguments [List] :index A comma-separated list of indices to restrict the results # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled + # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled *Deprecated* # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Double] :min_score Include only documents with a specific `_score` value in the result # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [List] :routing A comma-separated list of specific routing values diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index 76c163c09..ea2b184a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Long] :version Explicit version number for concurrency control # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb index 53cecae21..4718f5507 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Long] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number # @option arguments [Long] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term 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 e2d46061d..0e589d707 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) # @option arguments [String] :conflicts What to do when the delete by query hits version conflicts? (options: abort, proceed) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [String] :q Query in the Lucene query string syntax @@ -41,7 +41,7 @@ module Actions # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout. # @option arguments [Long] :max_docs Maximum number of documents to process (default: all documents) - # @option arguments [List] :sort A comma-separated list of : pairs + # @option arguments [List] :sort A comma-separated list of : pairs *Deprecated* # @option arguments [Long] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes # @option arguments [Boolean] :version Specify whether to return document version as part of a hit diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 39c520ced..1b4e75be1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Eql request body. Use the `query` to limit the query scope. (*Required*) # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb index 29fc1f33b..1850034b8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb index 05524b67d..61c41eb4c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb index 82533f110..22185a563 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb index 54af83516..0f82bc738 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [List] :fields A comma-separated list of field names # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :include_unmapped Indicates whether unmapped fields should be included in the response. # @option arguments [List] :filters An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent # @option arguments [List] :types Only return results for fields that have one of the types in the list diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb index 0656e652b..1806e233a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index 1affde48e..b8a702199 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb index 94b0c6070..b75e6b7f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb @@ -25,7 +25,7 @@ module Actions # Explore graph analytics # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Graph Query DSL (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index 1c295ca2c..a11e71e30 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) # @option arguments [String] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create) # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Long] :version Explicit version number for concurrency control # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) 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 3f16cc4c6..7d79bfd01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb @@ -25,12 +25,12 @@ module Actions # Add an index block # # @option arguments [List] :index A comma separated list of indices to add a block to - # @option arguments [String] :block The block to add (one of read, write, read_only or metadata) + # @option arguments [String] :block The block to add (one of read, write, read_only or metadata) (options: metadata, read, read_only, write) # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index-modules-blocks.html#add-index-block 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 c36521680..7138e8161 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :query Clear query caches # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :request Clear request cache # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb index 64df55857..41b6424f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index 06397232b..df8c28431 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-index.html 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 15cc639d3..a54215218 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 @@ -25,7 +25,7 @@ module Actions # Delete data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers 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 56da37f23..4d6e28e1d 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 @@ -25,7 +25,7 @@ module Actions # Delete data streams # # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # 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 ed420f5ca..c02bfb807 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 @@ -25,7 +25,7 @@ module Actions # Deletes the data stream options of the selected data streams # # @option arguments [List] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers 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 aa2e38299..09f82f716 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :flush Whether flush or not before analyzing the index disk usage. Defaults to true # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-disk-usage.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb index a1abe49e4..cc97104cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. # @option arguments [Hash] :headers Custom HTTP headers 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 a0da58aa0..446f6badd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [List] :index A comma-separated list of index names to filter aliases # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # 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 365754eb1..04b7afbfc 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 @@ -32,7 +32,7 @@ module Actions # @option arguments [List] :fields A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/field-usage-stats.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb index 7db51d28d..581c7cb46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-flush.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index d18d9e58d..6fe00b48c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Long] :max_num_segments The number of segments the index should be merged into (default: dynamic) # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb index 9a42b4110..c1f0498f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb @@ -28,8 +28,8 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [String] :features Return only information on specified index features (options: aliases, mappings, settings) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :features Return only information on specified index features (options: aliases, mappings, settings) # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 0f371c780..d2b6c90eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [List] :index A comma-separated list of index names to filter aliases # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # 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 24f6cdcd8..7d213b42b 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 @@ -25,7 +25,7 @@ module Actions # Get data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers 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 0023cd639..c87ff45dc 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 @@ -25,7 +25,7 @@ module Actions # Get data streams # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :verbose Whether the maximum timestamp for each data stream should be calculated and returned (default: false) 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 e9c80b071..ec2f7e835 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 @@ -25,7 +25,7 @@ module Actions # Returns the data stream options of the selected data streams # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # 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 86047b8ae..b57b0cb99 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 @@ -29,7 +29,7 @@ module Actions # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # 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 b089fe0b7..8a034894d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers 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 b641761c9..a3d9c749e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index 8b98335eb..0256a171b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # 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 f3d6e642e..0109cea5e 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 @@ -25,7 +25,7 @@ module Actions # Update data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams whose lifecycle will be updated; use `*` to set the lifecycle to all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers 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 2961d628e..9943a6b33 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 @@ -25,7 +25,7 @@ module Actions # Updates the data stream options of the selected data streams # # @option arguments [List] :name A comma-separated list of data streams whose options will be updated; use `*` to set the options to all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers 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 bb02fee85..a5cef66d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :write_index_only When true, applies mappings only to the write index of an alias or data stream # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The mapping definition (*Required*) 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 63cf8fadf..0d10eaa1b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :reopen Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false` # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The index settings to be updated (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index ba12b93e0..fcc89c987 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-recovery.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb index a560c7ac9..aa41f5556 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html 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 694082818..01c8c5c4d 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 @@ -27,7 +27,7 @@ module Actions # @option arguments [List] :index A comma-separated list of index names to reload analyzers for # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :resource changed resource to reload analyzers from if applicable # @option arguments [Hash] :headers Custom HTTP headers # 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 ed06dc346..b8ac6bde3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb @@ -26,9 +26,9 @@ module Actions # # @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression. - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression. + # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression. *Deprecated* # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). Only allowed when providing an index expression. - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression. (options: open, closed, hidden, none, all) # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond # @option arguments [Hash] :headers Custom HTTP headers # 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 61994fce6..edb6b1716 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb @@ -25,7 +25,7 @@ module Actions # Resolve indices # # @option arguments [List] :name A comma-separated list of names or wildcard expressions - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb index 518ae3ebb..bcb08a1f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb @@ -27,7 +27,7 @@ module Actions # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene. *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # 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 35579a4fe..92415dfd1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-shards-stores.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index ac6a27236..a92cd703c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -24,7 +24,7 @@ module Indices module Actions # Get index statistics # - # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk) + # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, mappings, merge, recovery, request_cache, refresh, search, segments, shard_stats, store, translog, warmer, bulk, dense_vector, sparse_vector) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards) # @option arguments [List] :fielddata_fields A comma-separated list of fields for the `fielddata` index metric (supports wildcards) @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards) # @option arguments [Boolean] :include_segment_file_sizes Whether to report 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 set to true segment stats will include stats for segments that are not currently loaded into memory - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb index 9883b21a6..05333ac0e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb @@ -24,12 +24,12 @@ module Indices module Actions # Unfreeze an index # - # @option arguments [String] :index The name of the index to unfreeze + # @option arguments [List] :index A comma separated list of indices to remove a block from # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # 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 a5a8b7c51..5c73b97bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Boolean] :explain Return detailed information about the error # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :q Query in the Lucene query string syntax # @option arguments [String] :analyzer The analyzer to use for the query string # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb index 692bff970..6470af823 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb @@ -25,7 +25,7 @@ module Actions # Delete an inference endpoint # # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion) # @option arguments [Boolean] :dry_run If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned. # @option arguments [Boolean] :force If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields). # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb index 734517714..8e76f67bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb @@ -25,7 +25,7 @@ module Actions # Get an inference endpoint # # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-inference-api.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb index ff15eae3b..d2b06da7b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb @@ -25,7 +25,7 @@ module Actions # Perform inference on the service # # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion) # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference payload (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb index 22df4b226..a59232497 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb @@ -25,7 +25,7 @@ module Actions # Create an inference endpoint # # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion) # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*) 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 82aa0bf39..e9b3e654a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an AlibabaCloud AI Search inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion, rerank, space_embedding, text_embedding) # @option arguments [String] :alibabacloud_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 16bbc4e79..40b4a3b99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an Amazon Bedrock inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion, text_embedding) # @option arguments [String] :amazonbedrock_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb index dafc063d1..1bc20277c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an Amazon SageMaker inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: text_embedding, completion, chat_completion, sparse_embedding, rerank) # @option arguments [String] :amazonsagemaker_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 93ae7f9bc..4edb8d164 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an Anthropic inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion) # @option arguments [String] :anthropic_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 c8e4339a3..a72631df2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an Azure AI studio inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion, rerank, text_embedding) # @option arguments [String] :azureaistudio_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 a89fd8735..ba6598bf7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an Azure OpenAI inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion, text_embedding) # @option arguments [String] :azureopenai_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 a0cbda952..5edbd1da8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create a Cohere inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion, rerank, text_embedding) # @option arguments [String] :cohere_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb index 888dfb138..7ced00b9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create a custom inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: text_embedding, sparse_embedding, rerank, completion) # @option arguments [String] :custom_inference_id The inference Id # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb index 581176f22..1084dac0e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create a DeepSeek inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion, chat_completion) # @option arguments [String] :deepseek_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 cd6edbf2d..3bd2f6814 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an Elasticsearch inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: rerank, sparse_embedding, text_embedding) # @option arguments [String] :elasticsearch_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 786397e59..5443efedc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an ELSER inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: sparse_embedding) # @option arguments [String] :elser_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 637145fee..a2525a63b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an Google AI Studio inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: completion, text_embedding) # @option arguments [String] :googleaistudio_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 5e22c08a4..f56a6ff9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create a Google Vertex AI inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: rerank, text_embedding, completion, chat_completion) # @option arguments [String] :googlevertexai_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 bded1403f..83af8f30a 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 @@ -24,7 +24,7 @@ module Inference module Actions # Create a Hugging Face inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: chat_completion, completion, rerank, text_embedding) # @option arguments [String] :huggingface_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 abe884a75..f4e8dd0a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an JinaAI inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: rerank, text_embedding) # @option arguments [String] :jinaai_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 ad34a80cb..4a0e83b82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create a Mistral inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: text_embedding, completion, chat_completion) # @option arguments [String] :mistral_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 91041b0ff..0ca7b4434 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create an OpenAI inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: chat_completion, completion, text_embedding) # @option arguments [String] :openai_inference_id The inference ID # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 64e54abb8..720777c30 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create a VoyageAI inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: text_embedding, rerank) # @option arguments [String] :voyageai_inference_id The inference ID # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers 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 282b26eb3..9de88b3b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb @@ -24,7 +24,7 @@ module Inference module Actions # Create a Watsonx inference endpoint # - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: text_embedding, chat_completion, completion) # @option arguments [String] :watsonx_inference_id The inference Id # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb index a78a89583..0c0c51d7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb @@ -25,7 +25,7 @@ module Actions # Update an inference endpoint # # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*) # 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 c6e8eed62..357a41cd4 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 @@ -27,8 +27,8 @@ module Actions # @option arguments [String] :datafeed_id The ID of the datafeed to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) - # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true) - # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true) *Deprecated* + # @option arguments [List] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The datafeed config (*Required*) # 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 e99e57f2f..252596da7 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 @@ -27,8 +27,8 @@ module Actions # @option arguments [String] :job_id The ID of the job to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false). Only set if datafeed_config is provided. # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided. - # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided. - # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided. (options: open, closed, hidden, none, all) + # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided. *Deprecated* + # @option arguments [List] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job (*Required*) # 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 a8e29e49e..35bb4d736 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 @@ -27,8 +27,8 @@ module Actions # @option arguments [String] :datafeed_id The ID of the datafeed to update # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) - # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true) - # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true) *Deprecated* + # @option arguments [List] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The datafeed update settings (*Required*) # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb index 7b9d777b7..1e3ed2131 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb @@ -29,7 +29,7 @@ module Actions # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb index 4e55791c4..909e08445 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb @@ -24,7 +24,6 @@ module Monitoring module Actions # Send monitoring data # - # @option arguments [String] :type Default document type for items which don't provide one *Deprecated* # @option arguments [String] :system_id Identifier of the monitored system # @option arguments [String] :system_api_version API Version of the monitored system # @option arguments [String] :interval Collection interval (e.g., '10s' or '10000ms') of the payload @@ -32,36 +31,20 @@ module Actions # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs, # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation. # - # *Deprecation notice*: - # Specifying types in urls has been deprecated - # Deprecated since version 7.0.0 - # - # # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8 # def bulk(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'monitoring.bulk' } - defined_params = [:type].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) - - _type = arguments.delete(:type) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST - path = if _type - "_monitoring/#{Utils.__listify(_type)}/bulk" - else - '_monitoring/bulk' - end + path = '_monitoring/bulk' params = Utils.process_params(arguments) payload = if body.is_a? Array diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index ba30c18f9..d2fc5a14d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled *Deprecated* # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [List] :routing A comma-separated list of specific routing values # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb index 248de84f3..59306bbbd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :positions Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs". + # @option arguments [List] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs". # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true). # @option arguments [Long] :version Explicit version number for concurrency control # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) 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 dcd816ff3..e72507282 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb @@ -29,8 +29,8 @@ module Actions # @option arguments [Long] :snapshots Number of samples of thread stacktrace (default: 10) # @option arguments [Long] :threads Specify the number of threads to provide information for (default: 3) # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) - # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block, mem) - # @option arguments [String] :sort The sort order for 'cpu' type (default: total) (options: cpu, total) + # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block, gpu, mem) + # @option arguments [String] :sort The sort order for 'cpu' type (default: total) (options: cpu, wait, block, gpu, mem) # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb index f1ff1930e..e57617d1e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb @@ -25,7 +25,7 @@ module Actions # Get node information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none) + # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: _all, _none, settings, os, process, remote_cluster_server, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations) # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb index 410ad9935..cf5c60b50 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb @@ -25,8 +25,8 @@ module Actions # Get node statistics # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure) - # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk, shard_stats) + # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, _none, adaptive_selection, allocations, breaker, discovery, fs, http, indexing_pressure, indices, ingest, jvm, os, process, repositories, script, script_cache, thread_pool, transport) + # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, mappings, merge, request_cache, recovery, refresh, search, segments, store, warmer, bulk, shard_stats, translog, dense_vector, sparse_vector) # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards) # @option arguments [List] :fielddata_fields A comma-separated list of fields for the `fielddata` index metric (supports wildcards) # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb index 02c40d808..694b390bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb @@ -25,7 +25,7 @@ module Actions # Get feature usage information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions) + # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, aggregations, rest_actions) # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # 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 423603cf7..6d0ed7fc8 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 @@ -25,9 +25,9 @@ module Actions # # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :keep_alive Specific the time to live for the point in time (*Required*) # @option arguments [Boolean] :allow_partial_search_results Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false) # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index c7bf9a7da..a30970e27 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -26,7 +26,7 @@ module Actions # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index d5f21a1a8..8a91999a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -35,9 +35,9 @@ module Actions # @option arguments [Integer] :from Starting offset (default: 0) # @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] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled + # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled *Deprecated* # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [String] :q Query in the Lucene query string syntax 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 6899ee4f4..5c170bcd4 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 @@ -29,7 +29,7 @@ module Actions # support SLA of official GA features. # # @option arguments [String] :collection_name The name of behavioral analytics collection - # @option arguments [String] :event_type Behavioral analytics event type. Available: page_view, search, search_click + # @option arguments [String] :event_type Behavioral analytics event type. Available: page_view, search, search_click (options: page_view, search, search_click) # @option arguments [Boolean] :debug If true, returns event information that will be stored # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The event definition (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb index 51d00d311..d4aaa0384 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb @@ -25,11 +25,11 @@ module Actions # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index c34c0d9f8..ec3aae54c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -25,9 +25,9 @@ module Actions # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled + # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled *Deprecated* # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [List] :routing A comma-separated list of specific routing values # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search 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 5ba52837d..c681c6081 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 @@ -31,7 +31,7 @@ module Actions # @option arguments [List] :index Clear the cache # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-clear-cache.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb index f23007f07..a9ff913fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :positions Specifies if term positions should be returned. # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random). - # @option arguments [String] :routing Specific routing value. + # @option arguments [List] :routing Specific routing value. # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true). # @option arguments [Long] :version Explicit version number for concurrency control # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index 36cb312ba..59d45c618 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :lang The script language (default: painless) # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Integer] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0) - # @option arguments [String] :routing Specific routing value + # @option arguments [List] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Long] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number # @option arguments [Long] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term 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 5ca8a2f32..c811b15ad 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) # @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none) # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)