[DOCS] EQL: Add filter_path param to EQL search API docs
#68537
Merged
Conversation
This file contains hidden or 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
jrodewig
added
>docs
elasticmachine
added
Team:QL (Deprecated)
Collaborator
|
Pinging @elastic/es-ql (Team:QL) |
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
astefan
approved these changes
Feb 4, 2021
Contributor
astefan
left a comment
astefan
left a comment
There was a problem hiding this comment.
LGTM.
Left one comment/suggestion though.
docs/reference/eql/eql.asciidoc
Outdated
| // TEST[setup:sec_logs] | ||
|
|
||
| Use the <<common-options-response-filtering,`filter_path`>> query parameter to | ||
| filter the properties returned in the API response. For example, the following |
Contributor
There was a problem hiding this comment.
I wouldn't call those elements "properties". I think it's more like components or elements. Or maybe leave out a name for them and just state that it's "filtering the response content".
Contributor
Author
There was a problem hiding this comment.
Thanks @astefan! I've reworded to avoid "properties."
jrodewig
added a commit
that referenced
this pull request
Feb 4, 2021
jrodewig
added a commit
that referenced
this pull request
Feb 4, 2021
jrodewig
added a commit
that referenced
this pull request
Feb 4, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Adds docs for the
filter_pathparameter to the EQL docs.While the
filter_pathparameter is already covered in our API conventions docs, response filtering is particularly useful for EQL users. Those users may not be aware of the parameter otherwise.Previews