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

[docs] Mark percolator response snippets properly 

Now the docs tests will catch any errors in the responses. This
would have caught the error fixed in
https://github.com/elastic/elasticsearch/pull/20351
This commit is contained in:
Nik Everett 2016-09-07 08:16:48 -04:00
parent d34fdaac5e
commit bebdec570f
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/reference/query-dsl/percolate-query.asciidoc
View File

@ -51,7 +51,7 @@ Register a query in the percolator:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
PUT /my-index/queries/1 PUT /my-index/queries/1?refresh
{ {
"query" : { "query" : {
"match" : { "match" : {
@ -88,7 +88,7 @@ The above request will yield the following response:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
{ {
"took": 5, "took": 13,
"timed_out": false, "timed_out": false,
"_shards": { "_shards": {
"total": 5, "total": 5,
@ -116,6 +116,7 @@ The above request will yield the following response:
} }
} }
-------------------------------------------------- --------------------------------------------------
// TESTRESPONSE[s/"took": 13,/"took": "$body.took",/]
<1> The query with id `1` matches our document. <1> The query with id `1` matches our document.
@ -179,9 +180,11 @@ Index response:
"successful": 1, "successful": 1,
"failed": 0 "failed": 0
}, },
"created": true "created": true,
"result": "created"
} }
-------------------------------------------------- --------------------------------------------------
// TESTRESPONSE
Percolating an existing document, using the index response as basis to build to new search request: Percolating an existing document, using the index response as basis to build to new search request:
@ -226,7 +229,7 @@ Save a query:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
PUT /my-index/queries/1 PUT /my-index/queries/1?refresh
{ {
"query" : { "query" : {
"match" : { "match" : {
@ -242,7 +245,7 @@ Save another query:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
PUT /my-index/queries/2 PUT /my-index/queries/2?refresh
{ {
"query" : { "query" : {
"match" : { "match" : {
@ -284,7 +287,7 @@ This will yield the following response.
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
{ {
"took": 83, "took": 7,
"timed_out": false, "timed_out": false,
"_shards": { "_shards": {
"total": 5, "total": 5,
@ -335,6 +338,7 @@ This will yield the following response.
} }
} }
-------------------------------------------------- --------------------------------------------------
// TESTRESPONSE[s/"took": 7,/"took": "$body.took",/]
Instead of the query in the search request highlighting the percolator hits, the percolator queries are highlighting Instead of the query in the search request highlighting the percolator hits, the percolator queries are highlighting
the document defined in the `percolate` query. the document defined in the `percolate` query.