Skip to content

Commit b23d928

Browse files
committed
[API] Updates API to specification 6dead788dfcc249ad670453d051bbe3b35555774
* reindex - adds :max_docs parameter, the maximum number of documents to reindex * search_mvt - adds :track_total_hitsm the number of hits matching the query to count accurately * security.grant_api_key - adds :refresh, if 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. * snapshot.delete - adds :wait_for_completion, if `true`, the request returns a response when the matching snapshots are all deleted.
1 parent 8de7283 commit b23d928

File tree

7 files changed

+14
-5
lines changed

7 files changed

+14
-5
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.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] :flat_settings Return settings in flat format (default: false)
4545
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
4646
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
47-
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
47+
# @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked Server default: 30s.
4848
# @option arguments [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
4949
# @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
5050
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ module Actions
6262
# This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.NOTE: Reindexing from remote clusters does not support manual or automatic slicing.If set to `auto`, Elasticsearch chooses the number of slices to use.
6363
# This setting will use one slice per shard, up to a certain limit.
6464
# If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards. Server default: 1.
65+
# @option arguments [Integer] :max_docs The maximum number of documents to reindex.
66+
# By default, all documents are reindexed.
67+
# If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.If `conflicts` is set to `proceed`, the reindex 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.
6568
# @option arguments [Time] :timeout The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.
6669
# By default, Elasticsearch waits for at least one minute before failing.
6770
# The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ module Actions
117117
# of the cell. Server default: grid.
118118
# @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000.
119119
# If 0, results don't include the hits layer. Server default: 10000.
120+
# @option arguments [Boolean, Integer] :track_total_hits The number of hits matching the query to count accurately.
121+
# If `true`, the exact number of hits is returned at the cost of some performance.
122+
# If `false`, the response does not include the total number of hits matching the query. Server default: 10000.
120123
# @option arguments [Boolean] :with_labels If `true`, the hits and aggs layers will contain additional point features representing
121124
# suggested label positions for the original features.
122125
# - `Point` and `MultiPoint` features will have one of the points selected.

elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ module Actions
2828
# To check the privileges of other users, you must use the run as feature.
2929
# To check whether a user has a specific list of privileges, use the has privileges API.
3030
#
31-
# @option arguments [String] :application The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications.
32-
# @option arguments [String] :priviledge The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.
33-
# @option arguments [String, nil] :username [TODO]
3431
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
3532
# when they occur.
3633
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response

elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ module Actions
3939
# If applicable, it also returns expiration information for the API key in milliseconds.
4040
# By default, API keys never expire. You can specify expiration information when you create the API keys.
4141
#
42+
# @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation
43+
# visible to search.
44+
# If 'wait_for', it waits for a refresh to make this operation visible to search.
45+
# If 'false', nothing is done with refreshes. Server default: false.
4246
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4347
# when they occur.
4448
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ module Actions
3030
# @option arguments [Time] :master_timeout The period to wait for the master node.
3131
# If the master node is not available before the timeout expires, the request fails and returns an error.
3232
# To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
33+
# @option arguments [Boolean] :wait_for_completion If `true`, the request returns a response when the matching snapshots are all deleted.
34+
# If `false`, the request returns a response as soon as the deletes are scheduled. Server default: true.
3335
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
3436
# when they occur.
3537
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response

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 = 'dc3690c592d7b3d1c8d238119e4fac01c6f91c90'.freeze
21+
ES_SPECIFICATION_COMMIT = '6dead788dfcc249ad670453d051bbe3b35555774'.freeze
2222
end
2323
end

0 commit comments

Comments
 (0)