From bf353a7dce86dda502a37379a82294408f4e53ab Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 13 Jan 2025 07:13:27 -0600 Subject: [PATCH] Add asynchronous search descriptions. (#781) * Add asynchronous search descriptions. Signed-off-by: Archer * Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Streamline formatting. Signed-off-by: Archer --------- Signed-off-by: Archer Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower --- spec/namespaces/asynchronous_search.yaml | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/spec/namespaces/asynchronous_search.yaml b/spec/namespaces/asynchronous_search.yaml index 13f77b0ca..bafc62a1c 100644 --- a/spec/namespaces/asynchronous_search.yaml +++ b/spec/namespaces/asynchronous_search.yaml @@ -9,7 +9,7 @@ paths: operationId: asynchronous_search.search.0 x-operation-group: asynchronous_search.search x-version-added: '1.0' - description: Perform an asynchronous search. + description: Performs an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api parameters: @@ -27,7 +27,7 @@ paths: operationId: asynchronous_search.get.0 x-operation-group: asynchronous_search.get x-version-added: '1.0' - description: Get partial responses from asynchronous search. + description: Gets partial responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results parameters: @@ -39,7 +39,7 @@ paths: operationId: asynchronous_search.delete.0 x-operation-group: asynchronous_search.delete x-version-added: '1.0' - description: Delete asynchronous search. + description: Deletes any responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results parameters: @@ -52,7 +52,7 @@ paths: operationId: asynchronous_search.stats.0 x-operation-group: asynchronous_search.stats x-version-added: '1.0' - description: Monitoring of asynchronous searches that are running, completed, and/or persisted. + description: Monitors any asynchronous searches that are `running`, `completed`, `persisted`. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: @@ -64,19 +64,22 @@ components: asynchronous_search.search::query.wait_for_completion_timeout: name: wait_for_completion_timeout in: query - description: The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is `300s`. Default is `1s`. + description: The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`. schema: type: string asynchronous_search.search::query.keep_on_completion: name: keep_on_completion in: query - description: Whether you want to save the results in the cluster after the search is complete. + description: Whether you want to save the results in the cluster after the search is complete. You can examine the stored results at a later time. schema: type: boolean asynchronous_search.search::query.keep_alive: name: keep_alive in: query - description: The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. If the query overruns this time, the process cancels this query automatically. + description: |- + The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. + The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. + If the query overruns this time, the process cancels this query automatically. schema: type: string asynchronous_search.search::query.index: