Update deprecated tags to follow YARD's conventions

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>
opensearch-project · Oct 20, 2022 · d456ce7 · d456ce7
1 parent 84fcd91
commit d456ce7
Show file tree

Hide file tree

Showing 35 changed files with 35 additions and 69 deletions.
diff --git 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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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*
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -24,7 +24,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-# <b>DEPRECATED:</b> Please use <tt>cluster_manager</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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*
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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*
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -31,8 +31,7 @@ module Actions
         # Returns information about whether a particular component template exist
         #
         # @option arguments [String] :name The name of the template
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -31,8 +31,7 @@ module Actions
         # Returns one or more component templates
         #
         # @option arguments [List] :name The comma separated names of the component templates
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -31,8 +31,7 @@ module Actions
         # Returns cluster settings.
         #
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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
         #
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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
@@ -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)
-        # <b>DEPRECATED:</b> Please use <tt>cluster_manager_timeout</tt> 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