From d210ca4c157fe101c0d53ba06f623a66724e9a46 Mon Sep 17 00:00:00 2001 From: Harsha Vamsi Kalluri Date: Mon, 14 Nov 2022 21:56:06 +0000 Subject: [PATCH] Update comments around deprecated and inclusive naming Signed-off-by: Harsha Vamsi Kalluri --- CHANGELOG.md | 2 + .../opensearch/api/actions/cat/allocation.rb | 5 +- .../api/actions/cat/cluster_manager.rb | 54 +++++++++++++++++++ .../lib/opensearch/api/actions/cat/indices.rb | 5 +- .../lib/opensearch/api/actions/cat/master.rb | 3 +- .../opensearch/api/actions/cat/nodeattrs.rb | 5 +- .../lib/opensearch/api/actions/cat/nodes.rb | 5 +- .../api/actions/cat/pending_tasks.rb | 5 +- .../lib/opensearch/api/actions/cat/plugins.rb | 5 +- .../api/actions/cat/repositories.rb | 5 +- .../lib/opensearch/api/actions/cat/shards.rb | 5 +- .../opensearch/api/actions/cat/snapshots.rb | 3 +- .../opensearch/api/actions/cat/templates.rb | 5 +- .../opensearch/api/actions/cat/thread_pool.rb | 5 +- .../cluster/delete_component_template.rb | 3 +- .../cluster/exists_component_template.rb | 5 +- .../actions/cluster/get_component_template.rb | 5 +- .../api/actions/cluster/get_settings.rb | 3 +- .../opensearch/api/actions/cluster/health.rb | 5 +- .../api/actions/cluster/pending_tasks.rb | 5 +- .../actions/cluster/put_component_template.rb | 3 +- .../api/actions/cluster/put_settings.rb | 3 +- .../opensearch/api/actions/cluster/reroute.rb | 5 +- .../opensearch/api/actions/cluster/state.rb | 5 +- .../dangling_indices/delete_dangling_index.rb | 3 +- .../dangling_indices/import_dangling_index.rb | 3 +- .../opensearch/api/actions/delete_script.rb | 3 +- .../api/actions/features/get_features.rb | 3 +- .../lib/opensearch/api/actions/get_script.rb | 3 +- .../api/actions/indices/add_block.rb | 3 +- .../opensearch/api/actions/indices/clone.rb | 3 +- .../opensearch/api/actions/indices/close.rb | 3 +- .../opensearch/api/actions/indices/create.rb | 3 +- .../opensearch/api/actions/indices/delete.rb | 3 +- .../api/actions/indices/delete_alias.rb | 3 +- .../actions/indices/delete_index_template.rb | 3 +- .../api/actions/indices/delete_template.rb | 3 +- .../actions/indices/exists_index_template.rb | 5 +- .../api/actions/indices/exists_template.rb | 5 +- .../lib/opensearch/api/actions/indices/get.rb | 3 +- .../api/actions/indices/get_index_template.rb | 5 +- .../api/actions/indices/get_mapping.rb | 5 +- .../api/actions/indices/get_settings.rb | 3 +- .../api/actions/indices/get_template.rb | 5 +- .../opensearch/api/actions/indices/open.rb | 2 +- .../api/actions/indices/put_alias.rb | 3 +- .../api/actions/indices/put_index_template.rb | 3 +- .../api/actions/indices/put_mapping.rb | 3 +- .../api/actions/indices/put_settings.rb | 3 +- .../api/actions/indices/put_template.rb | 3 +- .../api/actions/indices/rollover.rb | 3 +- .../opensearch/api/actions/indices/shrink.rb | 3 +- .../indices/simulate_index_template.rb | 3 +- .../api/actions/indices/simulate_template.rb | 3 +- .../opensearch/api/actions/indices/split.rb | 3 +- .../api/actions/indices/update_aliases.rb | 3 +- .../api/actions/ingest/delete_pipeline.rb | 3 +- .../api/actions/ingest/get_pipeline.rb | 3 +- .../api/actions/ingest/put_pipeline.rb | 3 +- .../lib/opensearch/api/actions/put_script.rb | 3 +- .../opensearch/api/actions/search_shards.rb | 2 +- .../actions/snapshot/cleanup_repository.rb | 3 +- .../opensearch/api/actions/snapshot/clone.rb | 3 +- .../opensearch/api/actions/snapshot/create.rb | 3 +- .../api/actions/snapshot/create_repository.rb | 3 +- .../opensearch/api/actions/snapshot/delete.rb | 2 +- .../api/actions/snapshot/delete_repository.rb | 3 +- .../opensearch/api/actions/snapshot/get.rb | 3 +- .../api/actions/snapshot/get_features.rb | 2 +- .../api/actions/snapshot/get_repository.rb | 4 +- .../api/actions/snapshot/restore.rb | 3 +- .../opensearch/api/actions/snapshot/status.rb | 3 +- .../api/actions/snapshot/verify_repository.rb | 3 +- opensearch-api/lib/opensearch/api/utils.rb | 8 +-- .../api/actions/cat/cluster_manager_spec.rb | 26 +++++++++ .../opensearch/api/actions/get_script_spec.rb | 4 +- .../opensearch/api/actions/hashie_spec.rb | 2 - .../api/actions/indices/clone_spec.rb | 4 +- .../spec/opensearch/api/utils_spec.rb | 12 ++--- .../spec/opensearch/transport/sniffer_spec.rb | 4 +- profile/benchmarking/measurable.rb | 2 +- 81 files changed, 258 insertions(+), 112 deletions(-) create mode 100644 opensearch-api/lib/opensearch/api/actions/cat/cluster_manager.rb create mode 100644 opensearch-api/spec/opensearch/api/actions/cat/cluster_manager_spec.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d8be9b29..d84dc7e25 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Added Sigv4 Support with `opensearch-aws-sigv4` gem ([#71](https://github.com/opensearch-project/opensearch-ruby/issues/71)) ### Changed +- Updated for inclusive naming ([#112](https://github.com/opensearch-project/opensearch-ruby/issues/112)) + ### Deprecated diff --git a/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb b/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb index d69c44f72..3d0acbfe4 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb @@ -33,8 +33,9 @@ module Actions # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information # @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, k, kb, m, mb, g, gb, t, tb, p, pb) - # @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 [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/cluster_manager.rb b/opensearch-api/lib/opensearch/api/actions/cat/cluster_manager.rb new file mode 100644 index 000000000..57f201bd2 --- /dev/null +++ b/opensearch-api/lib/opensearch/api/actions/cat/cluster_manager.rb @@ -0,0 +1,54 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +module OpenSearch + module API + module Cat + module Actions + # Returns information about the cluster_manager node. + # + # @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 cluster_manager node (default: false) + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node + # @option arguments [List] :h Comma-separated list of column names to display + # @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 [Hash] :headers Custom HTTP headers + # + # + def cluster_manager(arguments = {}) + headers = arguments.delete(:headers) || {} + + arguments = arguments.clone + + method = OpenSearch::API::HTTP_GET + path = '_cat/cluster_manager' + params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) + + body = nil + perform_request(method, path, params, body, headers).body + end + + # Register this action with its valid params when the module is loaded. + # + # @since 6.2.0 + ParamsRegistry.register(:cluster_manager, %i[ + format + local + cluster_manager_timeout + h + help + s + v + ].freeze) + end + end + end +end diff --git a/opensearch-api/lib/opensearch/api/actions/cat/indices.rb b/opensearch-api/lib/opensearch/api/actions/cat/indices.rb index e81371ef3..2d1ddff11 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/indices.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/indices.rb @@ -33,8 +33,9 @@ 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 [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* - # @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 cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager 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 [Boolean] :help Return help information diff --git a/opensearch-api/lib/opensearch/api/actions/cat/master.rb b/opensearch-api/lib/opensearch/api/actions/cat/master.rb index f39f23a9d..b99a65aad 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/master.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/master.rb @@ -23,7 +23,8 @@ # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. - + +# @deprecated Please use cluster_manager instead. module OpenSearch module API module Cat diff --git a/opensearch-api/lib/opensearch/api/actions/cat/nodeattrs.rb b/opensearch-api/lib/opensearch/api/actions/cat/nodeattrs.rb index 02374a36c..2e6626035 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/nodeattrs.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/nodeattrs.rb @@ -31,8 +31,9 @@ module Actions # Returns information about custom node attributes. # # @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 [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb b/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb index c40af3529..7538e5fb4 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb @@ -33,8 +33,9 @@ module Actions # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) # @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 [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) *Deprecated* - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from cluster_manager node (default: false) *Deprecated* + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/pending_tasks.rb b/opensearch-api/lib/opensearch/api/actions/cat/pending_tasks.rb index 3e3c43e6e..d02b13c5f 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/pending_tasks.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/pending_tasks.rb @@ -31,8 +31,9 @@ module Actions # Returns a concise representation of the cluster pending tasks. # # @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 [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb b/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb index 8ec42bd9e..99577438b 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb @@ -31,8 +31,9 @@ module Actions # Returns information about installed plugins across nodes node. # # @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 [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response diff --git a/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb b/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb index 1d99c1866..f3eae6930 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb @@ -32,8 +32,9 @@ module Actions # Returns information about snapshot repositories registered in the cluster. # # @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 - # @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 cluster_manager node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/shards.rb b/opensearch-api/lib/opensearch/api/actions/cat/shards.rb index 42e5bc4c1..1d84e18a2 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/shards.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/shards.rb @@ -33,8 +33,9 @@ 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 [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* - # @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 cluster_manager node (default: false) *Deprecated* + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb b/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb index 02379684d..3b6bf8e3e 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [List] :repository Name of repository from which to fetch the snapshot information # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/templates.rb b/opensearch-api/lib/opensearch/api/actions/cat/templates.rb index 6acabb427..a424e3b27 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/templates.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/templates.rb @@ -32,8 +32,9 @@ module Actions # # @option arguments [String] :name A pattern that returned template names must match # @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 [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cat/thread_pool.rb b/opensearch-api/lib/opensearch/api/actions/cat/thread_pool.rb index 1426d732a..697e65417 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/thread_pool.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/thread_pool.rb @@ -34,8 +34,9 @@ module Actions # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :size The multiplier in which to display values *Deprecated* (options: , k, m, g, t, p) - # @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 [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/delete_component_template.rb b/opensearch-api/lib/opensearch/api/actions/cluster/delete_component_template.rb index 5d91fad17..1b471608e 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/delete_component_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/delete_component_template.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/exists_component_template.rb b/opensearch-api/lib/opensearch/api/actions/cluster/exists_component_template.rb index 509905ac1..852ef88b3 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/exists_component_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/exists_component_template.rb @@ -31,8 +31,9 @@ module Actions # Returns information about whether a particular component template exist # # @option arguments [String] :name The name of the template - # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/get_component_template.rb b/opensearch-api/lib/opensearch/api/actions/cluster/get_component_template.rb index 632c7ce36..f5c77b95d 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/get_component_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/get_component_template.rb @@ -31,8 +31,9 @@ module Actions # Returns one or more component templates # # @option arguments [List] :name The comma separated names of the component templates - # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/get_settings.rb b/opensearch-api/lib/opensearch/api/actions/cluster/get_settings.rb index 44f9f2c51..ff39302f8 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/get_settings.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/get_settings.rb @@ -31,7 +31,8 @@ module Actions # Returns cluster settings. # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/health.rb b/opensearch-api/lib/opensearch/api/actions/cluster/health.rb index 7c4170134..f09c858c8 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/health.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/health.rb @@ -33,8 +33,9 @@ module Actions # @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 [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 + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [String] :wait_for_active_shards Wait until the specified number of shards is active # @option arguments [String] :wait_for_nodes Wait until the specified number of nodes is available diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/pending_tasks.rb b/opensearch-api/lib/opensearch/api/actions/cluster/pending_tasks.rb index 42ae29902..bab4cb9c7 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/pending_tasks.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/pending_tasks.rb @@ -31,8 +31,9 @@ module Actions # Returns a list of any cluster-level changes (e.g. create index, update mapping, # allocate or fail shard) which have not yet been executed. # - # @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 + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/put_component_template.rb b/opensearch-api/lib/opensearch/api/actions/cluster/put_component_template.rb index acc09ebbd..40b6b25c3 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/put_component_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/put_component_template.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The template definition (*Required*) # diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/put_settings.rb b/opensearch-api/lib/opensearch/api/actions/cluster/put_settings.rb index 02be85088..17834255c 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/put_settings.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/put_settings.rb @@ -31,7 +31,8 @@ module Actions # Updates the cluster settings. # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*) diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb b/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb index 60908525f..b7c8a1afe 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb @@ -33,8 +33,9 @@ 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, routing_table, master_node, version) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata (options: _all, blocks, metadata, nodes, routing_table, cluster_manager_node, version) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`) diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/state.rb b/opensearch-api/lib/opensearch/api/actions/cluster/state.rb index baa4fd2f3..70c9c2128 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/state.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/state.rb @@ -32,8 +32,9 @@ module Actions # # @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] :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 + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Number] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out diff --git a/opensearch-api/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb b/opensearch-api/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb index 2aba47d58..d2e8ba4a6 100644 --- a/opensearch-api/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb +++ b/opensearch-api/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to delete the dangling index # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb b/opensearch-api/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb index a7a49d94d..f9615be57 100644 --- a/opensearch-api/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb +++ b/opensearch-api/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to import the dangling index # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # def import_dangling_index(arguments = {}) diff --git a/opensearch-api/lib/opensearch/api/actions/delete_script.rb b/opensearch-api/lib/opensearch/api/actions/delete_script.rb index 7fb12de4c..1bde23eb7 100644 --- a/opensearch-api/lib/opensearch/api/actions/delete_script.rb +++ b/opensearch-api/lib/opensearch/api/actions/delete_script.rb @@ -31,7 +31,8 @@ module Actions # # @option arguments [String] :id Script ID # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/features/get_features.rb b/opensearch-api/lib/opensearch/api/actions/features/get_features.rb index 0acf5cde6..996cd634c 100644 --- a/opensearch-api/lib/opensearch/api/actions/features/get_features.rb +++ b/opensearch-api/lib/opensearch/api/actions/features/get_features.rb @@ -30,7 +30,8 @@ module Features module Actions # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/get_script.rb b/opensearch-api/lib/opensearch/api/actions/get_script.rb index 3cd279a14..b5d5abf86 100644 --- a/opensearch-api/lib/opensearch/api/actions/get_script.rb +++ b/opensearch-api/lib/opensearch/api/actions/get_script.rb @@ -30,7 +30,8 @@ module Actions # Returns a script. # # @option arguments [String] :id Script ID - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/add_block.rb b/opensearch-api/lib/opensearch/api/actions/indices/add_block.rb index ab314000b..fd9d3f696 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/add_block.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/add_block.rb @@ -33,7 +33,8 @@ module Actions # @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 [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @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) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/clone.rb b/opensearch-api/lib/opensearch/api/actions/indices/clone.rb index feb36cf97..c953348c2 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/clone.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/clone.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :index The name of the source index to clone # @option arguments [String] :target The name of the target index to clone into # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the cloned index before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/close.rb b/opensearch-api/lib/opensearch/api/actions/indices/close.rb index 97fb395c7..371d5d2c9 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/close.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/close.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [List] :index A comma separated list of indices to close # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @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) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/create.rb b/opensearch-api/lib/opensearch/api/actions/indices/create.rb index 6cf46469f..ce0a7b18e 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/create.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/create.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns. # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the index (`settings` and `mappings`) # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/delete.rb b/opensearch-api/lib/opensearch/api/actions/indices/delete.rb index 5731697ac..e45e3dbd5 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/delete.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/delete.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @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) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/delete_alias.rb b/opensearch-api/lib/opensearch/api/actions/indices/delete_alias.rb index a2272a299..b054b0124 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/delete_alias.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/delete_alias.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [List] :index A comma-separated list of index names (supports wildcards); use `_all` for all indices # @option arguments [List] :name A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. # @option arguments [Time] :timeout Explicit timestamp for the document - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/delete_index_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/delete_index_template.rb index 8697a2415..e3ba38c71 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/delete_index_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/delete_index_template.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/delete_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/delete_template.rb index 3afde4ea7..371b7cf2c 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/delete_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/delete_template.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/exists_index_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/exists_index_template.rb index d52fd58c5..40cdd696e 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/exists_index_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/exists_index_template.rb @@ -32,8 +32,9 @@ module Actions # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/exists_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/exists_template.rb index 01ba2144d..6e37c4cfa 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/exists_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/exists_template.rb @@ -32,8 +32,9 @@ module Actions # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/get.rb b/opensearch-api/lib/opensearch/api/actions/indices/get.rb index 9a01a6b1e..6a95a7c5b 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/get.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/get.rb @@ -37,7 +37,8 @@ module Actions # @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 [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 + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/get_index_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/get_index_template.rb index bf3c33992..ba7ea792a 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/get_index_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/get_index_template.rb @@ -32,8 +32,9 @@ module Actions # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/get_mapping.rb b/opensearch-api/lib/opensearch/api/actions/indices/get_mapping.rb index f39f43cd6..b3277a052 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/get_mapping.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/get_mapping.rb @@ -34,8 +34,9 @@ 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] :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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # # *Deprecation notice*: diff --git a/opensearch-api/lib/opensearch/api/actions/indices/get_settings.rb b/opensearch-api/lib/opensearch/api/actions/indices/get_settings.rb index 339abf6ba..d6fcb081a 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/get_settings.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/get_settings.rb @@ -32,7 +32,8 @@ 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 [List] :name The name of the settings that should be included - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @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) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/get_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/get_template.rb index 1927abc8b..388eba8cd 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/get_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/get_template.rb @@ -32,8 +32,9 @@ module Actions # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/open.rb b/opensearch-api/lib/opensearch/api/actions/indices/open.rb index c4c6e63f1..634c1d9a5 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/open.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/open.rb @@ -32,7 +32,7 @@ module Actions # # @option arguments [List] :index A comma separated list of indices to open # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) 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) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/put_alias.rb b/opensearch-api/lib/opensearch/api/actions/indices/put_alias.rb index 12a3f74ca..f068bf456 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/put_alias.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/put_alias.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. # @option arguments [String] :name The name of the alias to be created or updated # @option arguments [Time] :timeout Explicit timestamp for the document - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter` # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/put_index_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/put_index_template.rb index 5a4a749c5..fbc093153 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/put_index_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/put_index_template.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one # @option arguments [String] :cause User defined reason for creating/updating the index template - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The template definition (*Required*) # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/put_mapping.rb b/opensearch-api/lib/opensearch/api/actions/indices/put_mapping.rb index 23945bbd5..782b8653c 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/put_mapping.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/put_mapping.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @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) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/put_settings.rb b/opensearch-api/lib/opensearch/api/actions/indices/put_settings.rb index 078e4673e..30f7730c5 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/put_settings.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/put_settings.rb @@ -31,7 +31,8 @@ module Actions # Updates the index settings. # # @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 [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :preserve_existing Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/put_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/put_template.rb index f76359d85..33967697d 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/put_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/put_template.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :name The name of the template # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The template definition (*Required*) # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/rollover.rb b/opensearch-api/lib/opensearch/api/actions/indices/rollover.rb index 49c6b2b30..57e28429d 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/rollover.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/rollover.rb @@ -35,7 +35,8 @@ module Actions # @option arguments [String] :new_index The name of the rollover index # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The conditions that needs to be met for executing rollover diff --git a/opensearch-api/lib/opensearch/api/actions/indices/shrink.rb b/opensearch-api/lib/opensearch/api/actions/indices/shrink.rb index d4fcb8347..c81f1b325 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/shrink.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/shrink.rb @@ -34,7 +34,8 @@ module Actions # @option arguments [String] :target The name of the target index to shrink into # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false) # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/simulate_index_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/simulate_index_template.rb index c8c9fcac5..3cc82f040 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/simulate_index_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/simulate_index_template.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :name The name of the index (it must be a concrete index name) # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body New index template definition, which will be included in the simulation, as if it already exists in the system # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/simulate_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/simulate_template.rb index 5f6f6ec84..ca2fa535d 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/simulate_template.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/simulate_template.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :name The name of the index template # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified # diff --git a/opensearch-api/lib/opensearch/api/actions/indices/split.rb b/opensearch-api/lib/opensearch/api/actions/indices/split.rb index 6fe246594..0374e35a9 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/split.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/split.rb @@ -34,7 +34,8 @@ module Actions # @option arguments [String] :target The name of the target index to split into # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false) # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) diff --git a/opensearch-api/lib/opensearch/api/actions/indices/update_aliases.rb b/opensearch-api/lib/opensearch/api/actions/indices/update_aliases.rb index 60887480c..8a64f3d01 100644 --- a/opensearch-api/lib/opensearch/api/actions/indices/update_aliases.rb +++ b/opensearch-api/lib/opensearch/api/actions/indices/update_aliases.rb @@ -31,7 +31,8 @@ module Actions # Updates index aliases. # # @option arguments [Time] :timeout Request timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The definition of `actions` to perform (*Required*) # diff --git a/opensearch-api/lib/opensearch/api/actions/ingest/delete_pipeline.rb b/opensearch-api/lib/opensearch/api/actions/ingest/delete_pipeline.rb index 2b94386e9..28e424d25 100644 --- a/opensearch-api/lib/opensearch/api/actions/ingest/delete_pipeline.rb +++ b/opensearch-api/lib/opensearch/api/actions/ingest/delete_pipeline.rb @@ -31,7 +31,8 @@ module Actions # Deletes a pipeline. # # @option arguments [String] :id Pipeline ID - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/opensearch-api/lib/opensearch/api/actions/ingest/get_pipeline.rb b/opensearch-api/lib/opensearch/api/actions/ingest/get_pipeline.rb index e68528c9d..235c54be3 100644 --- a/opensearch-api/lib/opensearch/api/actions/ingest/get_pipeline.rb +++ b/opensearch-api/lib/opensearch/api/actions/ingest/get_pipeline.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/ingest/put_pipeline.rb b/opensearch-api/lib/opensearch/api/actions/ingest/put_pipeline.rb index 0e85b554b..12f3ece46 100644 --- a/opensearch-api/lib/opensearch/api/actions/ingest/put_pipeline.rb +++ b/opensearch-api/lib/opensearch/api/actions/ingest/put_pipeline.rb @@ -31,7 +31,8 @@ module Actions # Creates or updates a pipeline. # # @option arguments [String] :id Pipeline ID - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The ingest definition (*Required*) diff --git a/opensearch-api/lib/opensearch/api/actions/put_script.rb b/opensearch-api/lib/opensearch/api/actions/put_script.rb index b17f620a1..c7c652e7d 100644 --- a/opensearch-api/lib/opensearch/api/actions/put_script.rb +++ b/opensearch-api/lib/opensearch/api/actions/put_script.rb @@ -32,7 +32,8 @@ module Actions # @option arguments [String] :id Script ID # @option arguments [String] :context Script context # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master + # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The document (*Required*) # diff --git a/opensearch-api/lib/opensearch/api/actions/search_shards.rb b/opensearch-api/lib/opensearch/api/actions/search_shards.rb index d4180ba37..4318746a5 100644 --- a/opensearch-api/lib/opensearch/api/actions/search_shards.rb +++ b/opensearch-api/lib/opensearch/api/actions/search_shards.rb @@ -32,7 +32,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 [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [String] :routing Specific routing value - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager 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) diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/cleanup_repository.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/cleanup_repository.rb index 24c50a684..c367dbf9c 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/cleanup_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/cleanup_repository.rb @@ -31,7 +31,8 @@ module Actions # Removes stale data from repository. # # @option arguments [String] :repository A repository name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/clone.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/clone.rb index c80729992..079a2fa85 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/clone.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/clone.rb @@ -33,7 +33,8 @@ module Actions # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot The name of the snapshot to clone from # @option arguments [String] :target_snapshot The name of the cloned snapshot to create - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot clone definition (*Required*) # diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/create.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/create.rb index d229a0449..fe13a1d66 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/create.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/create.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot definition diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/create_repository.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/create_repository.rb index 345015659..2e6ca50b5 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/create_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/create_repository.rb @@ -31,7 +31,8 @@ module Actions # Creates a repository. # # @option arguments [String] :repository A repository name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :verify Whether to verify the repository after creation # @option arguments [Hash] :headers Custom HTTP headers diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/delete.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/delete.rb index 29b872607..8e91369ec 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/delete.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/delete.rb @@ -32,7 +32,7 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to cluster_manager node # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/delete_repository.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/delete_repository.rb index af3e58a44..3d8685df4 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/delete_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/delete_repository.rb @@ -31,7 +31,8 @@ module Actions # Deletes a repository. # # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/get.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/get.rb index 3288be142..43b03a158 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/get.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/get.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown # @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false. # @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true. diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/get_features.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/get_features.rb index 172fc48ca..a50cbd94e 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/get_features.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/get_features.rb @@ -30,7 +30,7 @@ module Snapshot module Actions # Returns a list of features which can be snapshotted in this cluster. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to cluster_manager node # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/get_repository.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/get_repository.rb index debc64524..22ae7c6b9 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/get_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/get_repository.rb @@ -31,8 +31,8 @@ module Actions # Returns information about a repository. # # @option arguments [List] :repository A comma-separated list of repository names - # @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 [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to cluster_manager node + # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # # diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb index 5473cb0ce..a1dbee83f 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Details of what to restore diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb index a8bd4a561..ebf750ca8 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb @@ -32,7 +32,8 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/verify_repository.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/verify_repository.rb index b0cab728a..7e8c817d3 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/verify_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/verify_repository.rb @@ -31,7 +31,8 @@ module Actions # Verifies a repository. # # @option arguments [String] :repository A repository name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node + # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/opensearch-api/lib/opensearch/api/utils.rb b/opensearch-api/lib/opensearch/api/utils.rb index a17f7c09d..0e410ee61 100644 --- a/opensearch-api/lib/opensearch/api/utils.rb +++ b/opensearch-api/lib/opensearch/api/utils.rb @@ -97,13 +97,13 @@ def __pathify(*segments) # in a single item. # # OpenSearch::API::Utils.__bulkify [ - # { :index => { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } }, - # { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } } + # { :index => { :_index => 'myindexA', :_id => '1', :data => { :title => 'Test' } } }, + # { :update => { :_index => 'myindexB', :_id => '2', :data => { :doc => { :title => 'Update' } } } } # ] # - # # => {"index":{"_index":"myindexA","_type":"mytype","_id":"1"}} + # # => {"index":{"_index":"myindexA","_id":"1"}} # # => {"title":"Test"} - # # => {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}} + # # => {"update":{"_index":"myindexB","_id":"2"}} # # => {"doc":{"title":"Update"}} # def __bulkify(payload) diff --git a/opensearch-api/spec/opensearch/api/actions/cat/cluster_manager_spec.rb b/opensearch-api/spec/opensearch/api/actions/cat/cluster_manager_spec.rb new file mode 100644 index 000000000..37cbaf93e --- /dev/null +++ b/opensearch-api/spec/opensearch/api/actions/cat/cluster_manager_spec.rb @@ -0,0 +1,26 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +require 'spec_helper' + +describe 'client.cat#cluster_manager' do + let(:expected_args) do + [ + 'GET', + '_cat/cluster_manager', + {}, + nil, + {} + ] + end + + it 'performs the request' do + expect(client_double.cat.cluster_manager).to eq({}) + end +end diff --git a/opensearch-api/spec/opensearch/api/actions/get_script_spec.rb b/opensearch-api/spec/opensearch/api/actions/get_script_spec.rb index 876de5d86..1f1c29e0d 100644 --- a/opensearch-api/spec/opensearch/api/actions/get_script_spec.rb +++ b/opensearch-api/spec/opensearch/api/actions/get_script_spec.rb @@ -49,11 +49,11 @@ context 'when the `lang` parameter is specificed' do let(:params) do - { master_timeout: '1s' } + { cluster_manager_timeout: '1s' } end it 'performs the request' do - expect(client_double.get_script(master_timeout: '1s', id: 'foo')).to eq({}) + expect(client_double.get_script(cluster_manager_timeout: '1s', id: 'foo')).to eq({}) end end end diff --git a/opensearch-api/spec/opensearch/api/actions/hashie_spec.rb b/opensearch-api/spec/opensearch/api/actions/hashie_spec.rb index 09067d890..40937593e 100644 --- a/opensearch-api/spec/opensearch/api/actions/hashie_spec.rb +++ b/opensearch-api/spec/opensearch/api/actions/hashie_spec.rb @@ -45,7 +45,6 @@ "hits": [ { "_index": "myindex", - "_type": "mytype", "_id": "1", "_score": 0.51104903, "_source": { @@ -63,7 +62,6 @@ }, "facets": { "tags": { - "_type": "terms", "missing": 0, "total": 10, "other": 0, diff --git a/opensearch-api/spec/opensearch/api/actions/indices/clone_spec.rb b/opensearch-api/spec/opensearch/api/actions/indices/clone_spec.rb index af1d6afc8..95ecefc97 100644 --- a/opensearch-api/spec/opensearch/api/actions/indices/clone_spec.rb +++ b/opensearch-api/spec/opensearch/api/actions/indices/clone_spec.rb @@ -88,7 +88,7 @@ let(:params) do { timeout: '1s', - master_timeout: '10s', + cluster_manager_timeout: '10s', wait_for_active_shards: 1 } end @@ -97,7 +97,7 @@ expect(client_double.indices.clone(index: 'my_source_index', target: 'my_target_index', timeout: '1s', - master_timeout: '10s', + cluster_manager_timeout: '10s', wait_for_active_shards: 1)).to eq({}) end end diff --git a/opensearch-api/spec/opensearch/api/utils_spec.rb b/opensearch-api/spec/opensearch/api/utils_spec.rb index 7f9f7cfe4..b9e91f708 100644 --- a/opensearch-api/spec/opensearch/api/utils_spec.rb +++ b/opensearch-api/spec/opensearch/api/utils_spec.rb @@ -109,19 +109,19 @@ let(:result) do utils.__bulkify [ - { :index => { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } }, - { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } }, - { :delete => { :_index => 'myindexC', :_type => 'mytypeC', :_id => '3' } } + { :index => { :_index => 'myindexA', :_id => '1', :data => { :title => 'Test' } } }, + { :update => { :_index => 'myindexB', :_id => '2', :data => { :doc => { :title => 'Update' } } } }, + { :delete => { :_index => 'myindexC', :_id => '3' } } ] end let(:expected_string) do <<-PAYLOAD.gsub(/^\s+/, '') - {"index":{"_index":"myindexA","_type":"mytype","_id":"1"}} + {"index":{"_index":"myindexA","_id":"1"}} {"title":"Test"} - {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}} + {"update":{"_index":"myindexB","_id":"2"}} {"doc":{"title":"Update"}} - {"delete":{"_index":"myindexC","_type":"mytypeC","_id":"3"}} + {"delete":{"_index":"myindexC","_id":"3"}} PAYLOAD end diff --git a/opensearch-transport/spec/opensearch/transport/sniffer_spec.rb b/opensearch-transport/spec/opensearch/transport/sniffer_spec.rb index cbce5547f..022f2e46d 100644 --- a/opensearch-transport/spec/opensearch/transport/sniffer_spec.rb +++ b/opensearch-transport/spec/opensearch/transport/sniffer_spec.rb @@ -93,7 +93,7 @@ "ip" => "127.0.0.1", "version" => "7.0.0", "roles" => [ - "master", + "cluster_manager", "data", "ingest" ], @@ -135,7 +135,7 @@ end it 'parses the roles' do - expect(sniffer.hosts[0][:roles]).to eq(['master', + expect(sniffer.hosts[0][:roles]).to eq(['cluster_manager', 'data', 'ingest']) end diff --git a/profile/benchmarking/measurable.rb b/profile/benchmarking/measurable.rb index 296f942ea..25953e196 100644 --- a/profile/benchmarking/measurable.rb +++ b/profile/benchmarking/measurable.rb @@ -247,7 +247,7 @@ def client def dataset_slices(slice_size=10000) @dataset_slices ||= begin dataset.collect do |d| - { index: { _index: INDEX, _type: '_doc', data: d } } + { index: { _index: INDEX, data: d } } end.each_slice(slice_size) end end