Skip to content

Commit bd5486b

Browse files
committed
[API] Generates e194c704d2949312ed19e0582c29a873beee68db
1 parent a2679f3 commit bd5486b

File tree

13 files changed

+42
-15
lines changed

13 files changed

+42
-15
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ module Actions
3535
#
3636
# @option arguments [String] :time The unit used to display time values.
3737
# @option arguments [Boolean] :ts If true, returns `HH:MM:SS` and Unix epoch timestamps. Server default: true.
38-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
38+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3939
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
4040
# Sorting defaults to ascending and can be changed by setting `:asc`
4141
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ module Actions
4444
# @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
4545
# @option arguments [String] :time The unit used to display time values.
4646
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
47-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
47+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
4848
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
4949
# Sorting defaults to ascending and can be changed by setting `:asc`
5050
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
# Get information about the master node, including the ID, bound IP address, and name.
2727
# IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
2828
#
29-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
29+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3030
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3131
# Sorting defaults to ascending and can be changed by setting `:asc`
3232
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
# Get information about custom node attributes.
2727
# IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
2828
#
29-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
29+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3030
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3131
# Sorting defaults to ascending and can be changed by setting `:asc`
3232
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
# Get information about cluster-level changes that have not yet taken effect.
2727
# IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
2828
#
29-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
29+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3030
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3131
# Sorting defaults to ascending and can be changed by setting `:asc`
3232
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
# Get a list of plugins running on each node of a cluster.
2727
# IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
2828
#
29-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
29+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3030
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3131
# Sorting defaults to ascending and can be changed by setting `:asc`
3232
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ module Actions
3434
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
3535
# @option arguments [Array<String>] :nodes Unique node identifiers, which are used to limit the response.
3636
# @option arguments [String] :parent_task_id The parent task identifier, which is used to limit the response.
37-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
37+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3838
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3939
# Sorting defaults to ascending and can be changed by setting `:asc`
4040
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module Actions
2929
#
3030
# @option arguments [String] :name The name of the template to return.
3131
# Accepts wildcard expressions. If omitted, all templates are returned.
32-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
32+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3333
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3434
# Sorting defaults to ascending and can be changed by setting `:asc`
3535
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module API
2323
module Indices
2424
module Actions
2525
# Roll over to a new index.
26-
# TIP: It is recommended to use the index lifecycle rollover action to automate rollovers.
26+
# TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.
2727
# The rollover API creates a new index for a data stream or index alias.
2828
# The API behavior depends on the rollover target.
2929
# **Roll over a data stream**

elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ module Actions
5353
# Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.
5454
# It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.
5555
# * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down.
56-
# * When requested with `wait_for_completion=false`, a task id is returned, which can be used via the task management API to monitor, debug, or cancel the task. The task may disappear or fail if the node shuts down.
56+
# * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down.
5757
# When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.
5858
# Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.
5959
# Refer to the linked documentation for examples of how to reindex documents.

0 commit comments

Comments
 (0)