From 79f537bfb4eb353f0c6fe6163b1b6dd4b5fd0272 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 26 Sep 2024 08:28:31 -0700 Subject: [PATCH] [OpenAPI] Edit search application summaries (#2926) (cherry picked from commit 7f06834185c2b465e0da4fae1ff0c4f39b32d818) --- output/openapi/elasticsearch-openapi.json | 20 ++++++----- .../elasticsearch-serverless-openapi.json | 20 ++++++----- output/schema/schema.json | 34 +++++++++---------- .../delete/SearchApplicationsDeleteRequest.ts | 3 +- .../BehavioralAnalyticsDeleteRequest.ts | 1 + .../get/SearchApplicationsGetRequest.ts | 2 +- .../BehavioralAnalyticsGetRequest.ts | 2 +- .../put/SearchApplicationsPutRequest.ts | 2 +- .../BehavioralAnalyticsPutRequest.ts | 2 +- .../search/SearchApplicationsSearchRequest.ts | 4 ++- 10 files changed, 51 insertions(+), 39 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 27b54f0551..5b15e612ce 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -27333,7 +27333,7 @@ "tags": [ "search_application.get" ], - "summary": "Returns the details about a search application", + "summary": "Get search application details", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html" }, @@ -27370,7 +27370,7 @@ "tags": [ "search_application.put" ], - "summary": "Creates or updates a search application", + "summary": "Create or update a search application", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html" }, @@ -27435,7 +27435,8 @@ "tags": [ "search_application.delete" ], - "summary": "Deletes a search application", + "summary": "Delete a search application", + "description": "Remove a search application and its associated alias. Indices attached to the search application are not removed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html" }, @@ -27474,7 +27475,7 @@ "tags": [ "search_application.get_behavioral_analytics" ], - "summary": "Returns the existing behavioral analytics collections", + "summary": "Get behavioral analytics collections", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html" }, @@ -27496,7 +27497,7 @@ "tags": [ "search_application.put_behavioral_analytics" ], - "summary": "Creates a behavioral analytics collection", + "summary": "Create a behavioral analytics collection", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html" }, @@ -27534,6 +27535,7 @@ "search_application.delete_behavioral_analytics" ], "summary": "Delete a behavioral analytics collection", + "description": "The associated data stream is also deleted.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html" }, @@ -27572,7 +27574,7 @@ "tags": [ "search_application.get_behavioral_analytics" ], - "summary": "Returns the existing behavioral analytics collections", + "summary": "Get behavioral analytics collections", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html" }, @@ -27664,7 +27666,8 @@ "tags": [ "search_application.search" ], - "summary": "Perform a search against a search application", + "summary": "Run a search application search", + "description": "Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html" }, @@ -27692,7 +27695,8 @@ "tags": [ "search_application.search" ], - "summary": "Perform a search against a search application", + "summary": "Run a search application search", + "description": "Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 374a6e2e38..fc26602054 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -17043,7 +17043,7 @@ "tags": [ "search_application.get" ], - "summary": "Returns the details about a search application", + "summary": "Get search application details", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html" }, @@ -17080,7 +17080,7 @@ "tags": [ "search_application.put" ], - "summary": "Creates or updates a search application", + "summary": "Create or update a search application", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html" }, @@ -17145,7 +17145,8 @@ "tags": [ "search_application.delete" ], - "summary": "Deletes a search application", + "summary": "Delete a search application", + "description": "Remove a search application and its associated alias. Indices attached to the search application are not removed.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html" }, @@ -17184,7 +17185,7 @@ "tags": [ "search_application.get_behavioral_analytics" ], - "summary": "Returns the existing behavioral analytics collections", + "summary": "Get behavioral analytics collections", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html" }, @@ -17206,7 +17207,7 @@ "tags": [ "search_application.put_behavioral_analytics" ], - "summary": "Creates a behavioral analytics collection", + "summary": "Create a behavioral analytics collection", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html" }, @@ -17244,6 +17245,7 @@ "search_application.delete_behavioral_analytics" ], "summary": "Delete a behavioral analytics collection", + "description": "The associated data stream is also deleted.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html" }, @@ -17282,7 +17284,7 @@ "tags": [ "search_application.get_behavioral_analytics" ], - "summary": "Returns the existing behavioral analytics collections", + "summary": "Get behavioral analytics collections", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html" }, @@ -17374,7 +17376,8 @@ "tags": [ "search_application.search" ], - "summary": "Perform a search against a search application", + "summary": "Run a search application search", + "description": "Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html" }, @@ -17402,7 +17405,8 @@ "tags": [ "search_application.search" ], - "summary": "Perform a search against a search application", + "summary": "Run a search application search", + "description": "Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 0c642cef72..96aa2dea28 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -14193,7 +14193,7 @@ "stability": "beta" } }, - "description": "Deletes a search application.", + "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", "name": "search_application.delete", "request": { @@ -14228,7 +14228,7 @@ "stability": "experimental" } }, - "description": "Delete a behavioral analytics collection.", + "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", "name": "search_application.delete_behavioral_analytics", "request": { @@ -14263,7 +14263,7 @@ "stability": "beta" } }, - "description": "Returns the details about a search application", + "description": "Get search application details.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", "name": "search_application.get", "request": { @@ -14298,7 +14298,7 @@ "stability": "experimental" } }, - "description": "Returns the existing behavioral analytics collections.", + "description": "Get behavioral analytics collections.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", "name": "search_application.get_behavioral_analytics", "request": { @@ -14402,7 +14402,7 @@ "stability": "beta" } }, - "description": "Creates or updates a search application.", + "description": "Create or update a search application.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", "name": "search_application.put", "request": { @@ -14440,7 +14440,7 @@ "stability": "experimental" } }, - "description": "Creates a behavioral analytics collection.", + "description": "Create a behavioral analytics collection.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", "name": "search_application.put_behavioral_analytics", "request": { @@ -14503,7 +14503,7 @@ "stability": "beta" } }, - "description": "Perform a search against a search application.", + "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", "name": "search_application.search", "request": { @@ -183613,7 +183613,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a search application.", + "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "inherits": { "type": { "name": "RequestBase", @@ -183639,7 +183639,7 @@ } ], "query": [], - "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L35" + "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L36" }, { "kind": "response", @@ -183667,7 +183667,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a behavioral analytics collection.", + "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", "inherits": { "type": { "name": "RequestBase", @@ -183693,7 +183693,7 @@ } ], "query": [], - "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L35" + "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L36" }, { "kind": "response", @@ -183721,7 +183721,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the details about a search application", + "description": "Get search application details.", "inherits": { "type": { "name": "RequestBase", @@ -183775,7 +183775,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the existing behavioral analytics collections.", + "description": "Get behavioral analytics collections.", "inherits": { "type": { "name": "RequestBase", @@ -184020,7 +184020,7 @@ } } }, - "description": "Creates or updates a search application.", + "description": "Create or update a search application.", "inherits": { "type": { "name": "RequestBase", @@ -184122,7 +184122,7 @@ "body": { "kind": "no_body" }, - "description": "Creates a behavioral analytics collection.", + "description": "Create a behavioral analytics collection.", "inherits": { "type": { "name": "RequestBase", @@ -184197,7 +184197,7 @@ } ] }, - "description": "Perform a search against a search application.", + "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "inherits": { "type": { "name": "RequestBase", @@ -184243,7 +184243,7 @@ } } ], - "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L52" + "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L54" }, { "kind": "response", diff --git a/specification/search_application/delete/SearchApplicationsDeleteRequest.ts b/specification/search_application/delete/SearchApplicationsDeleteRequest.ts index 83dfdc7ae9..c0ec929057 100644 --- 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/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts b/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts index 4b34a48578..c6e9d8a612 100644 --- a/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts +++ b/specification/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 index 77ef2d4bb2..f9a7ed3378 100644 --- 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 index fbeb0553f4..f170772a34 100644 --- 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 index a062f082a2..df5efd5ff0 100644 --- 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 index 01db6bd546..b0b813c666 100644 --- 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 index ae0247b2c9..da4c175a4f 100644 --- 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