Skip to content

Commit 2e9ca64

Browse files
[OpenAPI] Edit search application summaries (#2926) (#2946)
(cherry picked from commit 7f06834) Co-authored-by: Lisa Cawley <[email protected]>
1 parent 7f3a5f3 commit 2e9ca64

File tree

10 files changed

+51
-39
lines changed

10 files changed

+51
-39
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 12 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 12 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 17 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/search_application/delete/SearchApplicationsDeleteRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base'
2020
import { Name } from '@_types/common'
2121

2222
/**
23-
* Deletes a search application.
23+
* Delete a search application.
24+
* Remove a search application and its associated alias. Indices attached to the search application are not removed.
2425
* @rest_spec_name search_application.delete
2526
* @availability stack since=8.8.0 stability=beta
2627
* @availability serverless stability=beta visibility=public

specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import { Name } from '@_types/common'
2121

2222
/**
2323
* Delete a behavioral analytics collection.
24+
* The associated data stream is also deleted.
2425
* @rest_spec_name search_application.delete_behavioral_analytics
2526
* @availability stack since=8.8.0 stability=experimental
2627
* @availability serverless stability=experimental visibility=public

specification/search_application/get/SearchApplicationsGetRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base'
2020
import { Name } from '@_types/common'
2121

2222
/**
23-
* Returns the details about a search application
23+
* Get search application details.
2424
* @rest_spec_name search_application.get
2525
* @availability stack since=8.8.0 stability=beta
2626
* @availability serverless stability=beta visibility=public

specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base'
2020
import { Name } from '@_types/common'
2121

2222
/**
23-
* Returns the existing behavioral analytics collections.
23+
* Get behavioral analytics collections.
2424
* @rest_spec_name search_application.get_behavioral_analytics
2525
* @availability stack since=8.8.0 stability=experimental
2626
* @availability serverless stability=experimental visibility=public

specification/search_application/put/SearchApplicationsPutRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import { Name } from '@_types/common'
2121
import { SearchApplication } from '../_types/SearchApplication'
2222

2323
/**
24-
* Creates or updates a search application.
24+
* Create or update a search application.
2525
* @rest_spec_name search_application.put
2626
* @availability stack since=8.8.0 stability=beta
2727
* @availability serverless stability=beta visibility=public

specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base'
2020
import { Name } from '@_types/common'
2121

2222
/**
23-
* Creates a behavioral analytics collection.
23+
* Create a behavioral analytics collection.
2424
* @rest_spec_name search_application.put_behavioral_analytics
2525
* @availability stack since=8.8.0 stability=experimental
2626
* @availability serverless stability=experimental visibility=public

specification/search_application/search/SearchApplicationsSearchRequest.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ import { RequestBase } from '@_types/Base'
2222
import { Name } from '@_types/common'
2323

2424
/**
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
* @rest_spec_name search_application.search
2729
* @availability stack since=8.8.0 stability=beta
2830
* @availability serverless stability=beta visibility=public

0 commit comments

Comments
 (0)