[DOCS] EQL: Document get async EQL search API#57366
[DOCS] EQL: Document get async EQL search API#57366jrodewig merged 3 commits intoelastic:feature/async-eqlfrom jrodewig:docs__get-async-eql-search-api
Conversation
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-ql (:Query Languages/EQL) |
imotov
left a comment
There was a problem hiding this comment.
Left one minor correction about blocked requests. Otherwise LGTM.
|
|
||
| `wait_for_completion_timeout`:: | ||
| (Optional, <<time-units,time value>>) | ||
| Timeout duration to block other requests while waiting for the request to |
There was a problem hiding this comment.
I am not quite sure what you mean by "block other requests" here. It should only block the current request. Please let me know if you observed other behavior.
There was a problem hiding this comment.
You're correct. Thanks for catching this. I've updated the definition with 30518af.
| * An `is_partial` value of `true`, indicating the response does not contain | ||
| complete search results. | ||
| * An `is_running` value of `true`, indicating the search is async and ongoing. | ||
| * Partial search results, if available, in the `hits` property. |
There was a problem hiding this comment.
We don't have this for now, but hopefully, we will have some partial results soon. So, it might make sense to leave it.
There was a problem hiding this comment.
I'll leave this in for now. It'll be easy to remove later if wanted.
Adds documentation for the get async EQL search API.
Also updates existing docs to cross-reference the new
documentation.
Relates to #56852 and #49638.