Updated opensearch-php to reflect the latest OpenSearch API spec (202…

…5-01-26) (#269)

Signed-off-by: GitHub <[email protected]>
Co-authored-by: dblock <[email protected]>

CHANGELOG.md

@@ -28,6 +28,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed PHP 8.4 deprecations
 - Fixed outdated tests
 ### Updated APIs
+- Updated opensearch-php APIs to reflect [opensearch-api-specification@9df46f8](https://github.com/opensearch-project/opensearch-api-specification/commit/9df46f8134641ae5b429e3e9269858c7cb27e4f0)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@592336a](https://github.com/opensearch-project/opensearch-api-specification/commit/592336afb88844f0c5785ba4b085dba3884ac580)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@799d046](https://github.com/opensearch-project/opensearch-api-specification/commit/799d04622aeddce7b697665d63a29fc049e5088e)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@1422af3](https://github.com/opensearch-project/opensearch-api-specification/commit/1422af3cddc8140fe9c3d59ee0205b278e193bb9)

src/OpenSearch/Namespaces/AsynchronousSearchNamespace.php

@@ -74,9 +74,9 @@ public function get(array $params = [])
      * Performs an asynchronous search.
      *
      * $params['index']                       = (string) The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names.
-     * $params['keep_alive']                  = (string) 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.
-     * $params['keep_on_completion']          = (boolean) 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.
-     * $params['wait_for_completion_timeout'] = (string) 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`.
+     * $params['keep_alive']                  = (string) 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 exceeds this amount of time, the process cancels this query automatically.
+     * $params['keep_on_completion']          = (boolean) Whether to save the results in the cluster after the search is complete. You can examine the stored results at a later time.
+     * $params['wait_for_completion_timeout'] = (string) The amount of time to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`.
      * $params['pretty']                      = (boolean) Whether to pretty format the returned JSON response. (Default = false)
      * $params['human']                       = (boolean) Whether to return human readable values for statistics. (Default = true)
      * $params['error_trace']                 = (boolean) Whether to include the stack trace of returned errors. (Default = false)
@@ -98,7 +98,7 @@ public function search(array $params = [])
     }
 
     /**
-     * Monitors any asynchronous searches that are `running`, `completed`, `persisted`.
+     * Monitors any asynchronous searches that are `running`, `completed`, or `persisted`.
      *
      * $params['pretty']      = (boolean) Whether to pretty format the returned JSON response. (Default = false)
      * $params['human']       = (boolean) Whether to return human readable values for statistics. (Default = true)