Skip to content

Commit 593ba18

Browse files
committed
[API] Generates latest code from c87b1a22e846cc829f8d06c4958b0d2418b51375
1 parent 76c09b4 commit 593ba18

File tree

11 files changed

+24
-12
lines changed

11 files changed

+24
-12
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ module Actions
7878
# * JavaScript: Check out `client.helpers.*`
7979
# * .NET: Check out `BulkAllObservable`
8080
# * PHP: Check out bulk indexing.
81+
# * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
8182
# **Submitting bulk requests with cURL**
8283
# If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.
8384
# The latter doesn't preserve newlines. For example:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module Actions
2828
# IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
2929
#
3030
# @option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
31-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
31+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3232
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3333
# Sorting defaults to ascending and can be changed by setting `:asc`
3434
# or `:desc` as a suffix to the column name.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module Actions
2828
#
2929
# @option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information.
3030
# @option arguments [String] :bytes The unit used to display byte values.
31-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
31+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3232
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3333
# Sorting defaults to ascending and can be changed by setting `:asc`
3434
# or `:desc` as a suffix to the column name.

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module Actions
3131
# @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
3232
# It supports wildcards (`*`).
3333
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
34-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
34+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3535
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3636
# Sorting defaults to ascending and can be changed by setting `:asc`
3737
# or `:desc` as a suffix to the column name.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ module Actions
3030
# @option arguments [String, Array<String>] :fields Comma-separated list of fields used to limit returned information.
3131
# To retrieve all fields, omit this parameter.
3232
# @option arguments [String] :bytes The unit used to display byte values.
33-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
33+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3434
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3535
# Sorting defaults to ascending and can be changed by setting `:asc`
3636
# or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,12 @@ module Actions
2626
# By default, it returns only settings that have been explicitly defined.
2727
#
2828
# @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
29-
# @option arguments [Boolean] :include_defaults If `true`, returns default cluster settings from the local node.
29+
# @option arguments [Boolean] :include_defaults If `true`, also returns default values for all other cluster settings, reflecting the values
30+
# in the `elasticsearch.yml` file of one of the nodes in the cluster. If the nodes in your
31+
# cluster do not all have the same values in their `elasticsearch.yml` config files then the
32+
# values returned by this API may vary from invocation to invocation and may not reflect the
33+
# values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to
34+
# fetch the settings for each individual node in your cluster.
3035
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
3136
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
3237
# @option arguments [Time] :timeout Period to wait for a response.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ module Actions
3232
# - Update supported mapping parameters
3333
# - Change a field's mapping using reindexing
3434
# - Rename a field using a field alias
35-
# Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
35+
# Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
3636
#
3737
# @option arguments [String, Array] :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. (*Required*)
3838
# @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.

elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,18 @@ module Actions
3434
# * Azure AI Studio (`completion`, `text_embedding`)
3535
# * Azure OpenAI (`completion`, `text_embedding`)
3636
# * Cohere (`completion`, `rerank`, `text_embedding`)
37-
# * DeepSeek (`completion`, `chat_completion`)
37+
# * DeepSeek (`chat_completion`, `completion`)
3838
# * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
3939
# * ELSER (`sparse_embedding`)
4040
# * Google AI Studio (`completion`, `text_embedding`)
41-
# * Google Vertex AI (`rerank`, `text_embedding`)
41+
# * Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)
4242
# * Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)
43+
# * JinaAI (`rerank`, `text_embedding`)
44+
# * Llama (`chat_completion`, `completion`, `text_embedding`)
4345
# * Mistral (`chat_completion`, `completion`, `text_embedding`)
4446
# * OpenAI (`chat_completion`, `completion`, `text_embedding`)
45-
# * VoyageAI (`text_embedding`, `rerank`)
47+
# * VoyageAI (`rerank`, `text_embedding`)
4648
# * Watsonx inference integration (`text_embedding`)
47-
# * JinaAI (`text_embedding`, `rerank`)
4849
#
4950
# @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
5051
# @option arguments [String] :inference_id The inference Id (*Required*)

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ module Actions
5151
# In this case, the response includes a count of the version conflicts that were encountered.
5252
# Note that the handling of other error types is unaffected by the `conflicts` property.
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.
54+
# It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.
55+
# * 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.
57+
# When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.
58+
# Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.
5459
# Refer to the linked documentation for examples of how to reindex documents.
5560
#
5661
# @option arguments [Boolean] :refresh If `true`, the request refreshes affected shards to make this operation visible to search.

0 commit comments

Comments
 (0)