Skip to content

Commit 746435f

Browse files
committed
[DOCS] Updates source code docs
1 parent 5483035 commit 746435f

File tree

7 files changed

+10
-6
lines changed

7 files changed

+10
-6
lines changed

lib/elasticsearch-serverless/api/search_application/delete.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 SearchApplication
2424
module Actions
25-
# Deletes a search application.
25+
# Delete a search application.
26+
# Remove a search application and its associated alias. Indices attached to the search application are not removed.
2627
# This functionality is in Beta and is subject to change. The design and
2728
# code is less mature than official GA features and is being provided
2829
# as-is with no warranties. Beta features are not subject to the support

lib/elasticsearch-serverless/api/search_application/delete_behavioral_analytics.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ module API
2323
module SearchApplication
2424
module Actions
2525
# Delete a behavioral analytics collection.
26+
# The associated data stream is also deleted.
2627
# This functionality is Experimental and may be changed or removed
2728
# completely in a future release. Elastic will take a best effort approach
2829
# to fix any issues, but experimental features are not subject to the

lib/elasticsearch-serverless/api/search_application/get.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 SearchApplication
2424
module Actions
25-
# Returns the details about a search application
25+
# Get search application details.
2626
# This functionality is in Beta and is subject to change. The design and
2727
# code is less mature than official GA features and is being provided
2828
# as-is with no warranties. Beta features are not subject to the support

lib/elasticsearch-serverless/api/search_application/get_behavioral_analytics.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 SearchApplication
2424
module Actions
25-
# Returns the existing behavioral analytics collections.
25+
# Get behavioral analytics collections.
2626
# This functionality is Experimental and may be changed or removed
2727
# completely in a future release. Elastic will take a best effort approach
2828
# to fix any issues, but experimental features are not subject to the

lib/elasticsearch-serverless/api/search_application/put.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 SearchApplication
2424
module Actions
25-
# Creates or updates a search application.
25+
# Create or update a search application.
2626
# This functionality is in Beta and is subject to change. The design and
2727
# code is less mature than official GA features and is being provided
2828
# as-is with no warranties. Beta features are not subject to the support

lib/elasticsearch-serverless/api/search_application/put_behavioral_analytics.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 SearchApplication
2424
module Actions
25-
# Creates a behavioral analytics collection.
25+
# Create a behavioral analytics collection.
2626
# This functionality is Experimental and may be changed or removed
2727
# completely in a future release. Elastic will take a best effort approach
2828
# to fix any issues, but experimental features are not subject to the

lib/elasticsearch-serverless/api/search_application/search.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ module ElasticsearchServerless
2222
module API
2323
module SearchApplication
2424
module Actions
25-
# Perform a search against a search application.
25+
# Run a search application search.
26+
# Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
27+
# Unspecified template parameters are assigned their default values if applicable.
2628
# This functionality is in Beta and is subject to change. The design and
2729
# code is less mature than official GA features and is being provided
2830
# as-is with no warranties. Beta features are not subject to the support

0 commit comments

Comments
 (0)