Fix async search examples

Author: lcawl

docs/overlays/elasticsearch-shared-overlays.yaml

@@ -2463,6 +2463,30 @@ actions:
           examples:
             asyncSearchSubmitResponseExample1:
               $ref: "../../specification/async_search/submit/examples/response/AsyncSearchSubmitResponseExample1.yaml"
+  - target: "$.paths['/_async_search/status/{id}']['get']"
+    description: "Add examples for get async search status"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                asyncSearchStatusResponseExample1:
+                  $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml"
+                asyncSearchStatusResponseExample2:
+                  $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml"
+                asyncSearchStatusResponseExample3:
+                  $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml"
+  - target: "$.paths['/_async_search/{id}']['get']"
+    description: "Add examples for get async search"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                asyncSearchResponseExample1:
+                  $ref: "../../specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml"
 ## Examples for search applications
   - target: "$.paths['/_application/search_application']['get']"
     description: "Add examples for get search applications operation"

output/openapi/elasticsearch-openapi.json

@@ -29,7 +29,7 @@ import { ClusterStatistics, ShardStatistics } from '@_types/Stats'
 
 export class AsyncSearch<TDocument> {
   /**
-   * Partial aggregations results, coming from the shards that have already completed the execution of the query.
+   * Partial aggregations results, coming from the shards that have already completed running the query.
    */
   aggregations?: Dictionary<AggregateName, Aggregate>
   _clusters?: ClusterStatistics

output/openapi/elasticsearch-serverless-openapi.json

@@ -30,7 +30,9 @@ export class AsyncSearchResponseBase {
   is_partial: boolean
   /**
    * Indicates whether the search is still running or has completed.
-   * NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.
+   *
+   * > info
+   * > If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.
    */
   is_running: boolean
   /**
@@ -41,8 +43,8 @@ export class AsyncSearchResponseBase {
   start_time?: DateTime
   start_time_in_millis: EpochTime<UnitMillis>
   /**
-   * Indicates when the async search completed. Only present
-   * when the search has completed.
+   * Indicates when the async search completed.
+   * It is present only when the search has completed.
    */
   completion_time?: DateTime
   completion_time_in_millis?: EpochTime<UnitMillis>

output/schema/schema.json

@@ -45,7 +45,7 @@ export interface Request extends RequestBase {
   }
   query_parameters: {
     /**
-     * Specifies how long the async search should be available in the cluster.
+     * The length of time that the async search should be available in the cluster.
      * When not specified, the `keep_alive` set with the corresponding submit async request will be used.
      * Otherwise, it is possible to override the value and extend the validity of the request.
      * When this period expires, the search, if still running, is cancelled.