elasticsearch-api 9.1.1 → 9.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e1a709a1eac4218715eb692b5d6966b5a2702311f2f2083fb2cafb5b3fca4cd
-  data.tar.gz: cf212caadc4ffa0e92e4dacb192f80874c6a6e82e7c3fb8f5ab9f7adc6543eff
+  metadata.gz: 9fba50db24410f94fd3a5af07dc87f609a84f4738f1d7e3f6c1a73bc7607a355
+  data.tar.gz: 8ce16d17a18ae6e457b77fa083981277f0b3720f5fdd6d6e6d08db1ecfaf3208
 SHA512:
-  metadata.gz: 3291dda6177968b8c55741058934e73919635c880b2de168e4807e2027be53d598600e2cc1faa2c98de6b35eb84d94c1b977aaf07ba716338e67c65f0627b0a3
-  data.tar.gz: 67126f4ea20a2fff6ee3b6e81b9a860e588e7cca97e5221f315b413fa58d1aaf5da6683061e56c72ef81a8dc64f6f276b259431249aa8723cd11887a8b908563
+  metadata.gz: dca2538a397806ea934e78d1d8b39969ddfdd102ac11e6aabce0ee39d3254920b02e237040ae90a796b649fe1d8bff2b47bf77a31f2b721c882aec6fbff87488
+  data.tar.gz: a280cda6b49c2d57e6f860bed66118c5a92cfc6a0710a05d3761d1f54e2ec63ac04222cad198ac2e1435024d6050c59cb1660505b420b158e212781e765aaeeb

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

@@ -78,6 +78,7 @@ module Elasticsearch
       # * JavaScript: Check out `client.helpers.*`
       # * .NET: Check out `BulkAllObservable`
       # * PHP: Check out bulk indexing.
+      # * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
       # **Submitting bulk requests with cURL**
       # If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.
       # The latter doesn't preserve newlines. For example:
@@ -186,9 +187,7 @@ module Elasticsearch
                     body
                   end
 
-        headers.merge!({
-                         'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                       })
+        Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers))
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

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

@@ -28,7 +28,7 @@ module Elasticsearch
         # 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.
         #
         # @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`.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

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

@@ -28,7 +28,7 @@ module Elasticsearch
         #
         # @option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information.
         # @option arguments [String] :bytes The unit used to display byte values.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

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

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

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

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

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

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

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

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

data/lib/elasticsearch/api/actions/esql/get_query.rb

@@ -43,7 +43,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see [TODO]
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-get-query
         #
         def get_query(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'esql.get_query' }

data/lib/elasticsearch/api/actions/esql/list_queries.rb

@@ -42,7 +42,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see [TODO]
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-list-queries
         #
         def list_queries(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'esql.list_queries' }

data/lib/elasticsearch/api/actions/fleet/msearch.rb

@@ -108,9 +108,7 @@ module Elasticsearch
             payload = body
           end
 
-          headers.merge!({
-                           'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                         })
+          Utils.update_ndjson_headers!(headers, client.transport.options.dig(:transport_options, :headers))
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, payload, headers, request_opts)
           )

data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb

@@ -42,7 +42,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options
         #
         def delete_data_stream_options(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream_options' }

data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb

@@ -44,7 +44,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-options
         #
         def get_data_stream_options(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_options' }

data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb

@@ -49,7 +49,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options
         #
         def put_data_stream_options(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_options' }

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # - Update supported mapping parameters
         # - Change a field's mapping using reindexing
         # - Rename a field using a field alias
-        # 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.
+        # 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.
         #
         # @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*)
         # @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.

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

@@ -34,17 +34,18 @@ module Elasticsearch
         # * Azure AI Studio (`completion`, `text_embedding`)
         # * Azure OpenAI (`completion`, `text_embedding`)
         # * Cohere (`completion`, `rerank`, `text_embedding`)
-        # * DeepSeek (`completion`, `chat_completion`)
+        # * DeepSeek (`chat_completion`, `completion`)
         # * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
         # * ELSER (`sparse_embedding`)
         # * Google AI Studio (`completion`, `text_embedding`)
-        # * Google Vertex AI (`rerank`, `text_embedding`)
+        # * Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)
         # * Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)
+        # * JinaAI (`rerank`, `text_embedding`)
+        # * Llama (`chat_completion`, `completion`, `text_embedding`)
         # * Mistral (`chat_completion`, `completion`, `text_embedding`)
         # * OpenAI (`chat_completion`, `completion`, `text_embedding`)
-        # * VoyageAI (`text_embedding`, `rerank`)
+        # * VoyageAI (`rerank`, `text_embedding`)
         # * Watsonx inference integration (`text_embedding`)
-        # * JinaAI (`text_embedding`, `rerank`)
         #
         # @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
         # @option arguments [String] :inference_id The inference Id (*Required*)

data/lib/elasticsearch/api/actions/msearch.rb

@@ -120,9 +120,7 @@ module Elasticsearch
           payload = body
         end
 
-        headers.merge!({
-                         'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                       })
+        Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers))
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

data/lib/elasticsearch/api/actions/msearch_template.rb

@@ -93,9 +93,7 @@ module Elasticsearch
           payload = body
         end
 
-        headers.merge!({
-                         'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                       })
+        Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers))
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

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

@@ -51,6 +51,11 @@ module Elasticsearch
       # In this case, the response includes a count of the version conflicts that were encountered.
       # Note that the handling of other error types is unaffected by the `conflicts` property.
       # 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.
+      # It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.
+      # * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down.
+      # * 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.
+      # When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.
+      # Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.
       # Refer to the linked documentation for examples of how to reindex documents.
       #
       # @option arguments [Boolean] :refresh If `true`, the request refreshes affected shards to make this operation visible to search.

data/lib/elasticsearch/api/actions/text_structure/find_structure.rb

@@ -136,9 +136,7 @@ module Elasticsearch
                       body
                     end
 
-          headers.merge!({
-                           'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                         })
+          Utils.update_ndjson_headers!(headers, client.transport.options.dig(:transport_options, :headers))
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, payload, headers, request_opts)
           )

data/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb

@@ -0,0 +1,77 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Transform
+      module Actions
+        # Set upgrade_mode for transform indices.
+        # Sets a cluster wide upgrade_mode setting that prepares transform
+        # indices for an upgrade.
+        # When upgrading your cluster, in some circumstances you must restart your
+        # nodes and reindex your transform indices. In those circumstances,
+        # there must be no transforms running. You can close the transforms,
+        # do the upgrade, then open all the transforms again. Alternatively,
+        # you can use this API to temporarily halt tasks associated with the transforms
+        # and prevent new transforms from opening. You can also use this API
+        # during upgrades that do not require you to reindex your transform
+        # indices, though stopping transforms is not a requirement in that case.
+        # You can see the current value for the upgrade_mode setting by using the get
+        # transform info API.
+        #
+        # @option arguments [Boolean] :enabled When `true`, it enables `upgrade_mode` which temporarily halts all
+        #  transform tasks and prohibits new transform tasks from
+        #  starting.
+        # @option arguments [Time] :timeout The time to wait for the request to be completed. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode
+        #
+        def set_upgrade_mode(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_transform/set_upgrade_mode'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/utils.rb

@@ -177,6 +177,21 @@ module Elasticsearch
         end
       end
 
+      # Updates ndjson headers for msearch, bulk, and others
+      #
+      def update_ndjson_headers!(headers, client_headers)
+        current_content = client_headers.keys.find { |c| c.match?(/content-?_?type/i) } || 'content-type'
+        current_accept = client_headers.keys.find { |c| c.match?(/accept/i) } || 'accept'
+        version = client_headers[current_content].match(/compatible-with=([0-9]+)/)[1] || 9
+
+        headers.merge!(
+          {
+            current_content => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}",
+            current_accept => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}"
+          }
+        )
+      end
+
       extend self
     end
   end

data/lib/elasticsearch/api/version.rb

@@ -17,7 +17,7 @@
 
 module Elasticsearch
   module API
-    VERSION = '9.1.1'.freeze
-    ES_SPECIFICATION_COMMIT = '569f8b3768762075a47e5fa16a694b41cbc90a34'.freeze
+    VERSION = '9.1.2'.freeze
+    ES_SPECIFICATION_COMMIT = 'eeef9c87c1273e5dd3a5a313768bfa6728cd39cc'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 9.1.1
+  version: 9.1.2
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
@@ -785,6 +785,7 @@ files:
 - lib/elasticsearch/api/actions/transform/put_transform.rb
 - lib/elasticsearch/api/actions/transform/reset_transform.rb
 - lib/elasticsearch/api/actions/transform/schedule_now_transform.rb
+- lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb
 - lib/elasticsearch/api/actions/transform/start_transform.rb
 - lib/elasticsearch/api/actions/transform/stop_transform.rb
 - lib/elasticsearch/api/actions/transform/update_transform.rb