Skip to content

Commit da5ab86

Browse files
committed
[API] Updates source code docs to 58fbe0ad87bb94a0870b7df4db76587fbfcaa5b7
1 parent 1cf7b27 commit da5ab86

File tree

6 files changed

+16
-7
lines changed

6 files changed

+16
-7
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ module Actions
3333
# @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
3434
# @option arguments [String] :bytes The unit used to display byte values.
3535
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
36-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
37-
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
36+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
37+
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
38+
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
3839
# Sorting defaults to ascending and can be changed by setting `:asc`
3940
# or `:desc` as a suffix to the column name.
40-
# @option arguments [String] :time Unit used to display time values.
41+
# @option arguments [String] :time The unit used to display time values.
4142
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
4243
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
4344
# @option arguments [Boolean] :help When set to `true` will output available columns. This option

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ module Actions
3131
# Supports wildcards (`*`).
3232
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
3333
# @option arguments [String] :bytes The unit used to display byte values.
34-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35-
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
34+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
35+
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
36+
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
3637
# Sorting defaults to ascending and can be changed by setting `:asc`
3738
# or `:desc` as a suffix to the column name.
3839
# @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ module Actions
3232
# `_all` returns all repositories.
3333
# If any repository fails during the request, Elasticsearch returns an error.
3434
# @option arguments [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots.
35-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
36+
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
3637
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3738
# Sorting defaults to ascending and can be changed by setting `:asc`
3839
# or `:desc` as a suffix to the column name.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ module Actions
3333
# * Azure AI Studio (`completion`, `text_embedding`)
3434
# * Azure OpenAI (`completion`, `text_embedding`)
3535
# * Cohere (`completion`, `rerank`, `text_embedding`)
36+
# * DeepSeek (`completion`, `chat_completion`)
3637
# * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
3738
# * ELSER (`sparse_embedding`)
3839
# * Google AI Studio (`completion`, `text_embedding`)

elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ module Actions
2929
# If you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots.
3030
# This usage is preferred.
3131
# If needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.
32+
# Note that the stats will not be available for any shard snapshots in an ongoing snapshot completed by a node that (even momentarily) left the cluster.
33+
# Loading the stats from the repository is an expensive operation (see the WARNING below).
34+
# Therefore the stats values for such shards will be -1 even though the "stage" value will be "DONE", in order to minimize latency.
35+
# A "description" field will be present for a shard snapshot completed by a departed node explaining why the shard snapshot's stats results are invalid.
36+
# Consequently, the total stats for the index will be less than expected due to the missing values from these shards.
3237
# WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.
3338
# The API requires a read from the repository for each shard in each snapshot.
3439
# For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).

elasticsearch-api/lib/elasticsearch/api/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818
module Elasticsearch
1919
module API
2020
VERSION = '9.1.0'.freeze
21-
ES_SPECIFICATION_COMMIT = 'cd2d1fba07d3224129ca5a8d6018d86f67004fdf'.freeze
21+
ES_SPECIFICATION_COMMIT = '58fbe0ad87bb94a0870b7df4db76587fbfcaa5b7'.freeze
2222
end
2323
end

0 commit comments

Comments
 (0)