Skip to content

Commit 66ecf84

Browse files
committed
[API] Updates parameters and source code documentation
connector.get, connector.list - add include_deleted, a flag indicating whether to return connectors that have been soft-deleted. indices.rollover - removes target_failure_store parameter license.post_start_trial - removes timeout parameter xpack.info - adds human, defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true
1 parent b83532c commit 66ecf84

File tree

8 files changed

+10
-9
lines changed

8 files changed

+10
-9
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ module Actions
2929
# support SLA of official GA features.
3030
#
3131
# @option arguments [String] :connector_id The unique identifier of the connector to be returned.
32+
# @option arguments [Boolean] :include_deleted A flag indicating whether to return connectors that have been soft-deleted.
3233
# @option arguments [Hash] :headers Custom HTTP headers
3334
#
3435
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html
@@ -52,7 +53,7 @@ def get(arguments = {})
5253

5354
method = Elasticsearch::API::HTTP_GET
5455
path = "_connector/#{Utils.__listify(_connector_id)}"
55-
params = {}
56+
params = Utils.process_params(arguments)
5657

5758
Elasticsearch::API::Response.new(
5859
perform_request(method, path, params, body, headers, request_opts)

elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ module Actions
3434
# @option arguments [List] :connector_name A comma-separated list of connector names to fetch connector documents for
3535
# @option arguments [List] :service_type A comma-separated list of connector service types to fetch connector documents for
3636
# @option arguments [String] :query A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names
37+
# @option arguments [Boolean] :include_deleted A flag indicating whether to return connectors that have been soft-deleted.
3738
# @option arguments [Hash] :headers Custom HTTP headers
3839
#
3940
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-api.html

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ module Actions
2626
#
2727
# @option arguments [List] :name The comma separated names of the index templates
2828
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
29-
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
30-
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
29+
# @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked
30+
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
3131
# @option arguments [Hash] :headers Custom HTTP headers
3232
#
3333
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-template-exists-v1.html

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ module Actions
2626
#
2727
# @option arguments [String] :name A pattern that returned template names must match
2828
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
29-
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
30-
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
29+
# @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked
30+
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
3131
# @option arguments [Boolean] :include_defaults Return all relevant default configurations for the index template (default: false)
3232
# @option arguments [Hash] :headers Custom HTTP headers
3333
#

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ module Actions
2626
#
2727
# @option arguments [List] :name The comma separated names of the index templates
2828
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
29-
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
30-
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
29+
# @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked
30+
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
3131
# @option arguments [Hash] :headers Custom HTTP headers
3232
#
3333
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template-v1.html

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ module Actions
3232
# @option arguments [Time] :master_timeout Specify timeout for connection to master
3333
# @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
3434
# @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.
35-
# @option arguments [Boolean] :target_failure_store If set to true, the rollover action will be applied on the failure store of the data stream.
3635
# @option arguments [Hash] :headers Custom HTTP headers
3736
# @option arguments [Hash] :body The conditions that needs to be met for executing rollover
3837
#

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ module Actions
2727
# @option arguments [String] :type The type of trial license to generate (default: "trial")
2828
# @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
2929
# @option arguments [Time] :master_timeout Timeout for processing on master node
30-
# @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster
3130
# @option arguments [Hash] :headers Custom HTTP headers
3231
#
3332
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html

elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ module XPack
2424
module Actions
2525
# Retrieves information about the installed X-Pack features.
2626
#
27+
# @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true.
2728
# @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features
2829
# @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated*
2930
# @option arguments [Hash] :headers Custom HTTP headers

0 commit comments

Comments
 (0)