[OpenAPI] Edit search application summaries (#2926)

elastic · Sep 26, 2024 · 7f06834 · 7f06834
1 parent b8b5b43
commit 7f06834
Show file tree

Hide file tree

Showing 10 changed files with 51 additions and 39 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/search_application/delete/SearchApplicationsDeleteRequest.ts b/specification/search_application/delete/SearchApplicationsDeleteRequest.ts
@@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base'
 import { Name } from '@_types/common'
 
 /**
- * Deletes a search application.
+ * Delete a search application.
+ * Remove a search application and its associated alias. Indices attached to the search application are not removed.
  * @rest_spec_name search_application.delete
  * @availability stack since=8.8.0 stability=beta
  * @availability serverless stability=beta visibility=public

diff --git a/...cation/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts b/...cation/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts
@@ -21,6 +21,7 @@ import { Name } from '@_types/common'
 
 /**
  * Delete a behavioral analytics collection.
+ * The associated data stream is also deleted.
  * @rest_spec_name search_application.delete_behavioral_analytics
  * @availability stack since=8.8.0 stability=experimental
  * @availability serverless stability=experimental visibility=public

diff --git a/specification/search_application/get/SearchApplicationsGetRequest.ts b/specification/search_application/get/SearchApplicationsGetRequest.ts
@@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base'
 import { Name } from '@_types/common'
 
 /**
- * Returns the details about a search application
+ * Get search application details.
  * @rest_spec_name search_application.get
  * @availability stack since=8.8.0 stability=beta
  * @availability serverless stability=beta visibility=public

diff --git a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts
@@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base'
 import { Name } from '@_types/common'
 
 /**
- * Returns the existing behavioral analytics collections.
+ * Get behavioral analytics collections.
  * @rest_spec_name search_application.get_behavioral_analytics
  * @availability stack since=8.8.0 stability=experimental
  * @availability serverless stability=experimental visibility=public

diff --git a/specification/search_application/put/SearchApplicationsPutRequest.ts b/specification/search_application/put/SearchApplicationsPutRequest.ts
@@ -21,7 +21,7 @@ import { Name } from '@_types/common'
 import { SearchApplication } from '../_types/SearchApplication'
 
 /**
- * Creates or updates a search application.
+ * Create or update a search application.
  * @rest_spec_name search_application.put
  * @availability stack since=8.8.0 stability=beta
  * @availability serverless stability=beta visibility=public

diff --git a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts
@@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base'
 import { Name } from '@_types/common'
 
 /**
- * Creates a behavioral analytics collection.
+ * Create a behavioral analytics collection.
  * @rest_spec_name search_application.put_behavioral_analytics
  * @availability stack since=8.8.0 stability=experimental
  * @availability serverless stability=experimental visibility=public

diff --git a/specification/search_application/search/SearchApplicationsSearchRequest.ts b/specification/search_application/search/SearchApplicationsSearchRequest.ts
@@ -22,7 +22,9 @@ import { RequestBase } from '@_types/Base'
 import { Name } from '@_types/common'
 
 /**
- * Perform a search against a search application.
+ * Run a search application search.
+ * Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
+ * Unspecified template parameters are assigned their default values if applicable.
  * @rest_spec_name search_application.search
  * @availability stack since=8.8.0 stability=beta
  * @availability serverless stability=beta visibility=public