Skip to content

Commit 2e5ceb7

Browse files
committed
[API] Updates generated source code docs
1 parent 9d25757 commit 2e5ceb7

File tree

6 files changed

+7
-2
lines changed

6 files changed

+7
-2
lines changed

lib/elasticsearch-serverless/api/indices/delete_index_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module ElasticsearchServerless
2222
module API
2323
module Indices
2424
module Actions
25+
# Delete an index template.
2526
# The provided <index-template> may contain multiple template names separated by a comma. If multiple template
2627
# names are specified then there is no wildcard support and the provided names should match completely with
2728
# existing templates.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module ElasticsearchServerless
2222
module API
2323
module Indices
2424
module Actions
25+
# Get index templates.
2526
# Returns information about one or more index templates.
2627
#
2728
# @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

lib/elasticsearch-serverless/api/indices/put_index_template.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module ElasticsearchServerless
2222
module API
2323
module Indices
2424
module Actions
25-
# Creates or updates an index template.
25+
# Create or update an index template.
2626
# Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
2727
#
2828
# @option arguments [String] :name Index or template name (*Required*)

lib/elasticsearch-serverless/api/indices/simulate_index_template.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ module ElasticsearchServerless
2222
module API
2323
module Indices
2424
module Actions
25-
# Simulate matching the given index name against the index templates in the system
25+
# Simulate an index.
26+
# Returns the index configuration that would be applied to the specified index from an existing index template.
2627
#
2728
# @option arguments [String] :name Name of the index to simulate (*Required*)
2829
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.

lib/elasticsearch-serverless/api/indices/simulate_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module ElasticsearchServerless
2222
module API
2323
module Indices
2424
module Actions
25+
# Simulate an index template.
2526
# Returns the index configuration that would be applied by a particular index template.
2627
#
2728
# @option arguments [String] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.

lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ module API
2323
module MachineLearning
2424
module Actions
2525
# Starts a trained model deployment, which allocates the model to every machine learning node.
26+
#
2627
# @option arguments [String] :model_id The unique identifier of the trained model. Currently, only PyTorch models are supported. (*Required*)
2728
# @option arguments [Integer] :number_of_allocations The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. Server default: 1.
2829
# @option arguments [Hash] :headers Custom HTTP headers

0 commit comments

Comments
 (0)