[DOCS] Document EQL search REST API #52384
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Pinging @elastic/es-search (:Search/EQL) |
|
Pinging @elastic/es-docs (>docs) |
35 tasks
|
@elasticmachine update branch |
|
@elastic/es-ql |
astefan
approved these changes
Apr 24, 2020
| Comma-separated list of index names or <<indices-aliases,index aliases>> used to | ||
| limit the request. Accepts wildcard expressions. | ||
| + | ||
| To search all indices, use `_all`. |
There was a problem hiding this comment.
I believe it works with * as well: localhost:9200/*/_eql/search
There was a problem hiding this comment.
Addressed this with d09b286. Thanks!
| Reserved for future use. | ||
|
|
||
| `size`:: | ||
| (Optional, integer) |
There was a problem hiding this comment.
We say it's integer, but we seem to allow floating point numbers.
There was a problem hiding this comment.
Added float with d09b286. Thanks!
|
Thank you @astefan. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add API reference documentation for the EQL search API added with #49768.
For now, this PR only documents parameters expected for use with milestone 1 of #49581. Parameters used for joins are marked as
Reserved for future use.Remaining parameters and response will be documented alongside future development.