From d456ce77376af19d90549ea58a4274b0b3a23385 Mon Sep 17 00:00:00 2001 From: Harsha Vamsi Kalluri Date: Thu, 20 Oct 2022 18:12:49 +0000 Subject: [PATCH] Update deprecated tags to follow YARD's conventions Signed-off-by: Harsha Vamsi Kalluri --- opensearch-api/lib/opensearch/api/actions/cat/allocation.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cat/indices.rb | 5 ++--- opensearch-api/lib/opensearch/api/actions/cat/master.rb | 2 +- opensearch-api/lib/opensearch/api/actions/cat/nodeattrs.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cat/nodes.rb | 3 +-- .../lib/opensearch/api/actions/cat/pending_tasks.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cat/plugins.rb | 3 +-- .../lib/opensearch/api/actions/cat/repositories.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cat/shards.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cat/templates.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cat/thread_pool.rb | 3 +-- .../api/actions/cluster/exists_component_template.rb | 3 +-- .../opensearch/api/actions/cluster/get_component_template.rb | 3 +-- .../lib/opensearch/api/actions/cluster/get_settings.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cluster/health.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb | 3 +-- .../lib/opensearch/api/actions/features/get_features.rb | 3 +-- .../opensearch/api/actions/indices/exists_index_template.rb | 3 +-- .../lib/opensearch/api/actions/indices/exists_template.rb | 3 +-- .../lib/opensearch/api/actions/indices/get_index_template.rb | 3 +-- .../lib/opensearch/api/actions/indices/get_template.rb | 3 +-- .../lib/opensearch/api/actions/ingest/delete_pipeline.rb | 3 +-- .../lib/opensearch/api/actions/ingest/get_pipeline.rb | 3 +-- .../lib/opensearch/api/actions/ingest/put_pipeline.rb | 3 +-- .../opensearch/api/actions/snapshot/cleanup_repository.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/snapshot/clone.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/snapshot/create.rb | 3 +-- .../lib/opensearch/api/actions/snapshot/create_repository.rb | 3 +-- .../lib/opensearch/api/actions/snapshot/delete_repository.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/snapshot/get.rb | 3 +-- .../lib/opensearch/api/actions/snapshot/restore.rb | 3 +-- opensearch-api/lib/opensearch/api/actions/snapshot/status.rb | 3 +-- .../lib/opensearch/api/actions/snapshot/verify_repository.rb | 3 +-- .../spec/opensearch/api/actions/cat/master_spec.rb | 1 - 35 files changed, 35 insertions(+), 69 deletions(-) diff --git a/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb b/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb index 43bf1a517..28ca8b329 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/allocation.rb @@ -34,8 +34,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/cat/indices.rb b/opensearch-api/lib/opensearch/api/actions/cat/indices.rb index 28ae6826c..8b17791a9 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/indices.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/indices.rb @@ -33,9 +33,8 @@ 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 cluster_manager node (default: false) *Deprecated* - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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) diff --git a/opensearch-api/lib/opensearch/api/actions/cat/master.rb b/opensearch-api/lib/opensearch/api/actions/cat/master.rb index 00b0fe3f5..b99a65aad 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/master.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/master.rb @@ -24,7 +24,7 @@ # specific language governing permissions and limitations # under the License. -# DEPRECATED: Please use cluster_manager instead. +# @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 817391b82..ef34d1cb3 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/nodeattrs.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/nodeattrs.rb @@ -32,8 +32,7 @@ module Actions # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb b/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb index 3781d40c9..29a75b05d 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/nodes.rb @@ -34,8 +34,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false) # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from cluster_manager node (default: false) *Deprecated* - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 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 dea6514e4..c3f325d5a 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/pending_tasks.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/pending_tasks.rb @@ -32,8 +32,7 @@ module Actions # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb b/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb index dd9099de2..c0c8ae92a 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/plugins.rb @@ -32,8 +32,7 @@ module Actions # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb b/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb index ddfc59af6..bf486e29d 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/repositories.rb @@ -33,8 +33,7 @@ module Actions # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/cat/shards.rb b/opensearch-api/lib/opensearch/api/actions/cat/shards.rb index 3b928b9a7..24bb9e6b2 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/shards.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/shards.rb @@ -34,8 +34,7 @@ module Actions # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) *Deprecated* - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb b/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb index da7c4c5c1..3ca82c48f 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/snapshots.rb @@ -33,8 +33,7 @@ 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 - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/cat/templates.rb b/opensearch-api/lib/opensearch/api/actions/cat/templates.rb index 3fdc2e12c..f17d02a53 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/templates.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/templates.rb @@ -33,8 +33,7 @@ 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 cluster_manager node (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 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 a9c0f2d64..a92aa9563 100644 --- a/opensearch-api/lib/opensearch/api/actions/cat/thread_pool.rb +++ b/opensearch-api/lib/opensearch/api/actions/cat/thread_pool.rb @@ -35,8 +35,7 @@ module Actions # @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 cluster_manager node (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 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 5f408da06..d568ab6aa 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,7 @@ module Actions # Returns information about whether a particular component template exist # # @option arguments [String] :name The name of the template - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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] :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 2477aa0d4..4a7b29eb4 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,7 @@ module Actions # Returns one or more component templates # # @option arguments [List] :name The comma separated names of the component templates - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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] :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 45b1da91a..74ab37659 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/get_settings.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/get_settings.rb @@ -31,8 +31,7 @@ module Actions # Returns cluster settings. # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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. diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/health.rb b/opensearch-api/lib/opensearch/api/actions/cluster/health.rb index b374a57e8..76bb55c25 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/health.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/health.rb @@ -34,8 +34,7 @@ module Actions # @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 cluster_manager node (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 [String] :wait_for_active_shards Wait until the specified number of shards is active diff --git a/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb b/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb index f0b6896d2..0e0a1b010 100644 --- a/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb +++ b/opensearch-api/lib/opensearch/api/actions/cluster/reroute.rb @@ -34,8 +34,7 @@ module Actions # @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, cluster_manager_node, version) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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/features/get_features.rb b/opensearch-api/lib/opensearch/api/actions/features/get_features.rb index 2c20dc515..ce2955632 100644 --- a/opensearch-api/lib/opensearch/api/actions/features/get_features.rb +++ b/opensearch-api/lib/opensearch/api/actions/features/get_features.rb @@ -30,8 +30,7 @@ module Features module Actions # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot # - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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/indices/exists_index_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/exists_index_template.rb index 8047c5463..7012c27e7 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,7 @@ module Actions # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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] :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 a0df35d2f..524cbf85f 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,7 @@ 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) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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] :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_index_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/get_index_template.rb index b90c93e34..b3062d931 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,7 @@ 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) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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] :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_template.rb b/opensearch-api/lib/opensearch/api/actions/indices/get_template.rb index a4f490458..4c030d2e3 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,7 @@ 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) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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] :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/ingest/delete_pipeline.rb b/opensearch-api/lib/opensearch/api/actions/ingest/delete_pipeline.rb index 3ae3a985b..c3c9fd31e 100644 --- a/opensearch-api/lib/opensearch/api/actions/ingest/delete_pipeline.rb +++ b/opensearch-api/lib/opensearch/api/actions/ingest/delete_pipeline.rb @@ -31,8 +31,7 @@ module Actions # Deletes a pipeline. # # @option arguments [String] :id Pipeline ID - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 0d44e5942..13906b6e6 100644 --- a/opensearch-api/lib/opensearch/api/actions/ingest/get_pipeline.rb +++ b/opensearch-api/lib/opensearch/api/actions/ingest/get_pipeline.rb @@ -32,8 +32,7 @@ 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) - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 14168f68b..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,8 +31,7 @@ module Actions # Creates or updates a pipeline. # # @option arguments [String] :id Pipeline ID - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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/cleanup_repository.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/cleanup_repository.rb index 633f36905..f9c5f7b29 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/cleanup_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/cleanup_repository.rb @@ -31,8 +31,7 @@ module Actions # Removes stale data from repository. # # @option arguments [String] :repository A repository name - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 28ae1e5da..9b365689f 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/clone.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/clone.rb @@ -33,8 +33,7 @@ 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 - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 89f904c9d..e80cc12f5 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/create.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/create.rb @@ -32,8 +32,7 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 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 aada35467..d5b0db02a 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/create_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/create_repository.rb @@ -31,8 +31,7 @@ module Actions # Creates a repository. # # @option arguments [String] :repository A repository name - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 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 d3155e6f8..4e57efbbf 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/delete_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/delete_repository.rb @@ -31,8 +31,7 @@ module Actions # Deletes a repository. # # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 7adfbed44..a79123da6 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/get.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/get.rb @@ -32,8 +32,7 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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. diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb index 7d9f5b555..0110b1304 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/restore.rb @@ -32,8 +32,7 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 diff --git a/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb b/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb index 08721379e..55ac7ccad 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/status.rb @@ -32,8 +32,7 @@ module Actions # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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 bc38f8952..bb1f352c5 100644 --- a/opensearch-api/lib/opensearch/api/actions/snapshot/verify_repository.rb +++ b/opensearch-api/lib/opensearch/api/actions/snapshot/verify_repository.rb @@ -31,8 +31,7 @@ module Actions # Verifies a repository. # # @option arguments [String] :repository A repository name - # DEPRECATED: Please use cluster_manager_timeout instead. - # @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/spec/opensearch/api/actions/cat/master_spec.rb b/opensearch-api/spec/opensearch/api/actions/cat/master_spec.rb index e895370c5..84efbb12c 100644 --- a/opensearch-api/spec/opensearch/api/actions/cat/master_spec.rb +++ b/opensearch-api/spec/opensearch/api/actions/cat/master_spec.rb @@ -26,7 +26,6 @@ require 'spec_helper' -# DEPRECATED: Please use cluster_manager instead. describe 'client.cat#master' do let(:expected_args) do