honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Restructure `ids` to new query docs format (#41077)

This commit is contained in:
James Rodewig 2019-04-10 14:35:24 -04:00
parent 24446ceae0
commit a0b54a9a92
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/reference/query-dsl/ids-query.asciidoc
View File

@ -1,8 +1,9 @@
[[query-dsl-ids-query]] [[query-dsl-ids-query]]
=== Ids Query === Ids Query
Returns documents based on their IDs. This query uses document IDs stored in
the <<mapping-id-field,`_id`>> field.
Filters documents that only have the provided ids. Note, this query ==== Example request
uses the <<mapping-id-field,_id>> field.
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -16,3 +17,11 @@ GET /_search
} }
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
==== Top-level parameters for `ids`
[cols="v,v",options="header"]
|======
|Parameter |Description
|`values` |An array of <<mapping-id-field, document IDs>>.
|======