From 9db3982dd90fbdfab8289c155e6795eafc107cf4 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 16 Oct 2024 14:28:04 -0700 Subject: [PATCH] [OpenAPI] Improve analyze and async search summaries (#2924) --- output/openapi/elasticsearch-openapi.json | 32 +++++++++++-------- .../elasticsearch-serverless-openapi.json | 32 +++++++++++-------- output/schema/schema.json | 26 +++++++-------- .../delete/AsyncSearchDeleteRequest.ts | 4 +-- .../async_search/get/AsyncSearchGetRequest.ts | 3 +- .../status/AsyncSearchStatusRequest.ts | 4 +-- .../submit/AsyncSearchSubmitRequest.ts | 10 +++--- .../indices/analyze/IndicesAnalyzeRequest.ts | 3 +- 8 files changed, 63 insertions(+), 51 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 367d166fd4..9811e1815b 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -14,8 +14,8 @@ "tags": [ "search" ], - "summary": "Retrieves the results of a previously submitted async search request given its identifier", - "description": "If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "summary": "Get async search results", + "description": "Retrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "operationId": "async-search-get", "parameters": [ { @@ -78,8 +78,8 @@ "tags": [ "search" ], - "summary": "Deletes an async search by identifier", - "description": "If the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "summary": "Delete an async search", + "description": "If the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "operationId": "async-search-delete", "parameters": [ { @@ -114,8 +114,8 @@ "tags": [ "search" ], - "summary": "Get async search status\n", - "description": "Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get async search status", + "description": "Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "operationId": "async-search-status", "parameters": [ { @@ -150,8 +150,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit", "parameters": [ { @@ -309,8 +309,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit-1", "parameters": [ { @@ -9977,7 +9977,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -9992,7 +9993,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-1", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -10009,7 +10011,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-2", "parameters": [ { @@ -10029,7 +10032,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-3", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index d13f15d6aa..db9c562a25 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -14,8 +14,8 @@ "tags": [ "search" ], - "summary": "Retrieves the results of a previously submitted async search request given its identifier", - "description": "If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "summary": "Get async search results", + "description": "Retrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "operationId": "async-search-get", "parameters": [ { @@ -78,8 +78,8 @@ "tags": [ "search" ], - "summary": "Deletes an async search by identifier", - "description": "If the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "summary": "Delete an async search", + "description": "If the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "operationId": "async-search-delete", "parameters": [ { @@ -114,8 +114,8 @@ "tags": [ "search" ], - "summary": "Get async search status\n", - "description": "Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get async search status", + "description": "Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "operationId": "async-search-status", "parameters": [ { @@ -150,8 +150,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit", "parameters": [ { @@ -309,8 +309,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit-1", "parameters": [ { @@ -5849,7 +5849,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -5864,7 +5865,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-1", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -5881,7 +5883,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-2", "parameters": [ { @@ -5901,7 +5904,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-3", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 79190d7b92..f812c6455a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -171,7 +171,7 @@ "stability": "stable" } }, - "description": "Deletes an async search by identifier.\nIf the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "description": "Delete an async search.\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -208,7 +208,7 @@ "stability": "stable" } }, - "description": "Retrieves the results of a previously submitted async search request given its identifier.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "description": "Get async search results.\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -245,7 +245,7 @@ "stability": "stable" } }, - "description": "Get async search status\nRetrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -282,7 +282,7 @@ "stability": "stable" } }, - "description": "Runs a search request asynchronously.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "Run an async search.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -5971,7 +5971,7 @@ "stability": "stable" } }, - "description": "Performs analysis on a text string and returns the resulting tokens.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "docId": "indices-analyze", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", "name": "indices.analyze", @@ -86720,7 +86720,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an async search by identifier.\nIf the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "description": "Delete an async search.\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "inherits": { "type": { "name": "RequestBase", @@ -86774,7 +86774,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the results of a previously submitted async search request given its identifier.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "description": "Get async search results.\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "inherits": { "type": { "name": "RequestBase", @@ -86837,7 +86837,7 @@ } } ], - "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L55" + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L56" }, { "kind": "response", @@ -86880,7 +86880,7 @@ "body": { "kind": "no_body" }, - "description": "Get async search status\nRetrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "inherits": { "type": { "name": "RequestBase", @@ -87461,7 +87461,7 @@ } ] }, - "description": "Runs a search request asynchronously.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "Run an async search.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "inherits": { "type": { "name": "RequestBase", @@ -88062,7 +88062,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L287" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L289" }, { "kind": "response", @@ -127237,7 +127237,7 @@ } ] }, - "description": "Performs analysis on a text string and returns the resulting tokens.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "inherits": { "type": { "name": "RequestBase", @@ -127265,7 +127265,7 @@ } ], "query": [], - "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L92" + "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L93" }, { "kind": "response", diff --git a/specification/async_search/delete/AsyncSearchDeleteRequest.ts b/specification/async_search/delete/AsyncSearchDeleteRequest.ts index c59d0fda2e..3349954c83 100644 --- a/specification/async_search/delete/AsyncSearchDeleteRequest.ts +++ b/specification/async_search/delete/AsyncSearchDeleteRequest.ts @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an async search by identifier. - * If the search is still running, the search request will be cancelled. + * Delete an async search. + * If the asynchronous search is still running, it is cancelled. * Otherwise, the saved search results are deleted. * If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. * @rest_spec_name async_search.delete diff --git a/specification/async_search/get/AsyncSearchGetRequest.ts b/specification/async_search/get/AsyncSearchGetRequest.ts index 023882ebef..abc7c4f60a 100644 --- a/specification/async_search/get/AsyncSearchGetRequest.ts +++ b/specification/async_search/get/AsyncSearchGetRequest.ts @@ -22,7 +22,8 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Retrieves the results of a previously submitted async search request given its identifier. + * Get async search results. + * Retrieve the results of a previously submitted asynchronous search request. * If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. * @rest_spec_name async_search.get * @availability stack since=7.7.0 stability=stable diff --git a/specification/async_search/status/AsyncSearchStatusRequest.ts b/specification/async_search/status/AsyncSearchStatusRequest.ts index 786d9fc736..2b21d4daad 100644 --- a/specification/async_search/status/AsyncSearchStatusRequest.ts +++ b/specification/async_search/status/AsyncSearchStatusRequest.ts @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Get async search status - * Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + * Get async search status. + * Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results. * If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. * @rest_spec_name async_search.status * @availability stack since=7.11.0 stability=stable diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index 95d794c46e..5be3d05841 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -53,10 +53,12 @@ import { Sort, SortResults } from '@_types/sort' import { Duration } from '@_types/Time' /** - * Runs a search request asynchronously. - * When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - * Warning: Async search does not support scroll nor search requests that only include the suggest section. - * By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + * Run an async search. + * When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + * + * Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + * + * By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. * The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. * @rest_spec_name async_search.submit * @availability stack since=7.7.0 stability=stable diff --git a/specification/indices/analyze/IndicesAnalyzeRequest.ts b/specification/indices/analyze/IndicesAnalyzeRequest.ts index b15790bb1a..934e31ed63 100644 --- a/specification/indices/analyze/IndicesAnalyzeRequest.ts +++ b/specification/indices/analyze/IndicesAnalyzeRequest.ts @@ -25,7 +25,8 @@ import { Field, IndexName } from '@_types/common' import { TextToAnalyze } from './types' /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. + * The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens. * @doc_id indices-analyze * @rest_spec_name indices.analyze * @availability stack stability=stable