Skip to content

Commit 9403077

Browse files
committed
[API] Updates source code documentation
esql.async_query_get - Adds String parameter :format, a short version of the Accept header, e.g. json, yaml. Time parameters :master_timeout and :timeout have been added to the following APIs: * index_lifecycle_management ** delete_lifecycle ** get_lifecycle ** put_lifecycle ** start ** stop ** explain_lifecycle - Only :master_timeout * ingest: ** delete_geoip_database ** delete_ip_location_database ** put_geoip_database ** put_ip_location_database msearch adds new parameters: [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled *Deprecated* [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) [List] :routing A comma-separated list of specific routing values [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)
1 parent 89d8543 commit 9403077

File tree

12 files changed

+35
-9
lines changed

12 files changed

+35
-9
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ module Actions
2525
# Retrieves the results of a previously submitted async query request given its ID.
2626
#
2727
# @option arguments [String] :id The async query ID
28+
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
2829
# @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
2930
# @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available
3031
# @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.

elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.
2626
#
2727
# @option arguments [String] :policy The name of the index lifecycle policy
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
#
3032
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ilm-delete-lifecycle.html
@@ -48,7 +50,7 @@ def delete_lifecycle(arguments = {})
4850

4951
method = Elasticsearch::API::HTTP_DELETE
5052
path = "_ilm/policy/#{Utils.__listify(_policy)}"
51-
params = {}
53+
params = Utils.process_params(arguments)
5254

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

elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ module Actions
2727
# @option arguments [String] :index The name of the index to explain
2828
# @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM
2929
# @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
30+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
3031
# @option arguments [Hash] :headers Custom HTTP headers
3132
#
3233
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ilm-explain-lifecycle.html

elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Returns the specified policy definition. Includes the policy version and last modified date.
2626
#
2727
# @option arguments [String] :policy The name of the index lifecycle policy
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
#
3032
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ilm-get-lifecycle.html
@@ -50,7 +52,7 @@ def get_lifecycle(arguments = {})
5052
else
5153
'_ilm/policy'
5254
end
53-
params = {}
55+
params = Utils.process_params(arguments)
5456

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

elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Creates a lifecycle policy
2626
#
2727
# @option arguments [String] :policy The name of the index lifecycle policy
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
# @option arguments [Hash] :body The lifecycle policy definition to register
3032
#
@@ -49,7 +51,7 @@ def put_lifecycle(arguments = {})
4951

5052
method = Elasticsearch::API::HTTP_PUT
5153
path = "_ilm/policy/#{Utils.__listify(_policy)}"
52-
params = {}
54+
params = Utils.process_params(arguments)
5355

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

elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ module IndexLifecycleManagement
2424
module Actions
2525
# Start the index lifecycle management (ILM) plugin.
2626
#
27+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
28+
# @option arguments [Time] :timeout Explicit operation timeout
2729
# @option arguments [Hash] :headers Custom HTTP headers
2830
#
2931
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ilm-start.html
@@ -38,7 +40,7 @@ def start(arguments = {})
3840

3941
method = Elasticsearch::API::HTTP_POST
4042
path = '_ilm/start'
41-
params = {}
43+
params = Utils.process_params(arguments)
4244

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

elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ module IndexLifecycleManagement
2424
module Actions
2525
# Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
2626
#
27+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
28+
# @option arguments [Time] :timeout Explicit operation timeout
2729
# @option arguments [Hash] :headers Custom HTTP headers
2830
#
2931
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ilm-stop.html
@@ -38,7 +40,7 @@ def stop(arguments = {})
3840

3941
method = Elasticsearch::API::HTTP_POST
4042
path = '_ilm/stop'
41-
params = {}
43+
params = Utils.process_params(arguments)
4244

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

elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Deletes a geoip database configuration
2626
#
2727
# @option arguments [List] :id A comma-separated list of geoip database configurations to delete
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
#
3032
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-geoip-database-api.html
@@ -48,7 +50,7 @@ def delete_geoip_database(arguments = {})
4850

4951
method = Elasticsearch::API::HTTP_DELETE
5052
path = "_ingest/geoip/database/#{Utils.__listify(_id)}"
51-
params = {}
53+
params = Utils.process_params(arguments)
5254

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

elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Deletes an ip location database configuration
2626
#
2727
# @option arguments [List] :id A comma-separated list of ip location database configurations to delete
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
#
3032
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-ip-location-database-api.html
@@ -48,7 +50,7 @@ def delete_ip_location_database(arguments = {})
4850

4951
method = Elasticsearch::API::HTTP_DELETE
5052
path = "_ingest/ip_location/database/#{Utils.__listify(_id)}"
51-
params = {}
53+
params = Utils.process_params(arguments)
5254

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

elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Puts the configuration for a geoip database to be downloaded
2626
#
2727
# @option arguments [String] :id The id of the database configuration
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
# @option arguments [Hash] :body The database configuration definition (*Required*)
3032
#
@@ -50,7 +52,7 @@ def put_geoip_database(arguments = {})
5052

5153
method = Elasticsearch::API::HTTP_PUT
5254
path = "_ingest/geoip/database/#{Utils.__listify(_id)}"
53-
params = {}
55+
params = Utils.process_params(arguments)
5456

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

0 commit comments

Comments
 (0)