Skip to content

Commit a09b19d

Browse files
committed
[API] Updates generated API to df81426e814ecb513b012f2c0a706572964c606c
1 parent d4b4db1 commit a09b19d

17 files changed

Lines changed: 22 additions & 17 deletions

File tree

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ module Actions
3232
# - total store size of all shards, including shard replicas
3333
# These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.
3434
# To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
35+
# NOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.
36+
# IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to {https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions Elasticsearch billing dimensions}.
3537
# CAT APIs are only intended for human consumption using the command line or Kibana console.
3638
# They are not intended for use by applications. For application consumption, use an index endpoint.
3739
#

elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ module Actions
4848
# @option arguments [Hash] :headers Custom HTTP headers
4949
# @option arguments [Hash] :body request body
5050
#
51-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph
51+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph
5252
#
5353
def explore(arguments = {})
5454
request_opts = { endpoint: arguments[:endpoint] || 'graph.explore' }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ module Actions
3939
# this option for debugging only.
4040
# @option arguments [Hash] :headers Custom HTTP headers
4141
#
42-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration
42+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration
4343
#
4444
def get_migrate_reindex_status(arguments = {})
4545
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_migrate_reindex_status' }

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ module Actions
3434
# For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.
3535
# If the number of shards in the index is a prime number it can only be shrunk into a single primary shard
3636
# Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.
37+
# IMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.
3738
# The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.
3839
# A shrink operation:
3940
# * Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module Actions
3131
# NOTE: When moving to another node, the shard-level statistics for a shard are cleared.
3232
# Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.
3333
#
34-
# @option arguments [String, Array<String>] :metric Limit the information returned the specific metrics
34+
# @option arguments [String, Array<String>] :metric Comma-separated list of metrics used to limit the request.
3535
# @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
3636
# @option arguments [String, Array<String>] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
3737
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Actions
4949
# * OpenAI (`chat_completion`, `completion`, `text_embedding`)
5050
# * OpenShift AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)
5151
# * VoyageAI (`rerank`, `text_embedding`)
52-
# * Watsonx inference integration (`text_embedding`)
52+
# * Watsonx (`chat_completion`, `completion`, `rerank`, `text_embedding`)
5353
#
5454
# @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
5555
# @option arguments [String] :inference_id The inference Id (*Required*)

elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ module Actions
3030
# NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.
3131
# If the operator privileges feature is enabled, only operator users can use this API.
3232
#
33-
# @option arguments [Boolean] :acknowledge Specifies whether you acknowledge the license changes.
33+
# @option arguments [Boolean] :acknowledge To update a license, you must accept the acknowledge messages and set this parameter to `true`.
34+
# In particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.
3435
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
3536
# @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
3637
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module Actions
2929
# You must then re-submit the API request with the `acknowledge` parameter set to `true`.
3030
# To check the status of your basic license, use the get basic license API.
3131
#
32-
# @option arguments [Boolean] :acknowledge Whether the user has acknowledged acknowledge messages
32+
# @option arguments [Boolean] :acknowledge To start a basic license, you must accept the acknowledge messages and set this parameter to `true`.
3333
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
3434
# @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
3535
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module Actions
2828
# For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.
2929
# To check the status of your trial, use the get trial status API.
3030
#
31-
# @option arguments [Boolean] :acknowledge Whether the user has acknowledged acknowledge messages
31+
# @option arguments [Boolean] :acknowledge To start a trial, you must accept the acknowledge messages and set this parameter to `true`.
3232
# @option arguments [String] :type The type of trial license to generate Server default: trial.
3333
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
3434
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,12 @@ module API
2323
module Migration
2424
module Actions
2525
# Get deprecation information.
26-
# Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
27-
# TIP: This APIs is designed for indirect use by the Upgrade Assistant.
28-
# You are strongly recommended to use the Upgrade Assistant.
26+
# Returns information about deprecated features which are in use in the cluster.
27+
# The reported features include cluster, node, and index level settings that will be removed or changed in the next major version.
28+
# You must address the reported issues before upgrading to the next major version.
29+
# However, no action is required when upgrading within the current major version.
30+
# Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version.
31+
# Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.
2932
#
3033
# @option arguments [String] :index Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.
3134
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

0 commit comments

Comments
 (0)