[DOCS] Correct multi search API docs #52523
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
* Adds an example request to the top of the page. * Relocates several parameters erroneously listed under "Request body" to the appropriate "Query parameters" section. * Updates the "Request body" section to better document the NDJSON structure of msearch requests.
jrodewig
added
>docs
|
Pinging @elastic/es-search (:Search/Search) |
|
Pinging @elastic/es-docs (>docs) |
romseygeek
approved these changes
Feb 24, 2020
| This parameter also applies to <<indices-aliases,index aliases>> that point to a | ||
| missing or closed index. | ||
|
|
||
| `expand_wildcards`::: |
There was a problem hiding this comment.
Can this reuse the common-parms include as done for the request parameter above?
|
|
||
| `preference`::: | ||
| (Optional, string) | ||
| Node or shard used to perform the search. |
There was a problem hiding this comment.
Can we specify the default value here?
| `request_cache`::: | ||
| (Optional, boolean) | ||
| If `true`, the request cache can be used for this search. | ||
| See <<shard-request-cache>>. |
|
Thanks for your review @romseygeek. |
jrodewig
added a commit
that referenced
this pull request
Feb 24, 2020
* Adds an example request to the top of the page. * Relocates several parameters erroneously listed under "Request body" to the appropriate "Query parameters" section. * Updates the "Request body" section to better document the NDJSON structure of msearch requests.
jrodewig
added a commit
that referenced
this pull request
Feb 24, 2020
* Adds an example request to the top of the page. * Relocates several parameters erroneously listed under "Request body" to the appropriate "Query parameters" section. * Updates the "Request body" section to better document the NDJSON structure of msearch requests.
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.
Changes
to the appropriate "Query parameters" section.
structure of msearch requests.
Closes #52477.