Fix inconsistency in docs regarding single types (#28715)

This commit fixes some inconsistencies in the docs regarding single
types. The inconsistencies are between the verbiage and the relevant
snippets.
This commit is contained in:
olcbean 2018-02-26 16:08:37 +01:00 committed by Jason Tedor
parent 929dba8667
commit beb8b10556
6 changed files with 10 additions and 13 deletions

View File

@ -71,8 +71,7 @@ these documents. In case a search or bulk request got rejected, `_delete_by_quer
If you'd like to count version conflicts rather than cause them to abort then
set `conflicts=proceed` on the url or `"conflicts": "proceed"` in the request body.
Back to the API format, you can limit `_delete_by_query` to a single type. This
will only delete `tweet` documents from the `twitter` index:
Back to the API format, this will delete tweets from the `twitter` index:
[source,js]
--------------------------------------------------
@ -91,7 +90,7 @@ types at once, just like the search API:
[source,js]
--------------------------------------------------
POST twitter,blog/tweet,post/_delete_by_query
POST twitter,blog/_docs,post/_delete_by_query
{
"query": {
"match_all": {}

View File

@ -3,8 +3,7 @@
The delete API allows to delete a typed JSON document from a specific
index based on its id. The following example deletes the JSON document
from an index called twitter, under a type called tweet, with id valued
1:
from an index called `twitter`, under a type called `_doc`, with id `1`:
[source,js]
--------------------------------------------------
@ -75,7 +74,7 @@ DELETE /twitter/_doc/1?routing=kimchy
// CONSOLE
// TEST[continued]
The above will delete a tweet with id 1, but will be routed based on the
The above will delete a tweet with id `1`, but will be routed based on the
user. Note, issuing a delete without the correct routing, will cause the
document to not be deleted.

View File

@ -261,7 +261,7 @@ GET twitter/_doc/2?routing=user1
// CONSOLE
// TEST[continued]
The above will get a tweet with id 2, but will be routed based on the
The above will get a tweet with id `2`, but will be routed based on the
user. Note, issuing a get without the correct routing, will cause the
document not to be fetched.

View File

@ -160,9 +160,9 @@ POST _reindex
// TEST[setup:twitter]
`index` and `type` in `source` can both be lists, allowing you to copy from
lots of sources in one request. This will copy documents from the `tweet` and
lots of sources in one request. This will copy documents from the `_doc` and
`post` types in the `twitter` and `blog` index. It'd include the `post` type in
the `twitter` index and the `tweet` type in the `blog` index. If you want to be
the `twitter` index and the `_doc` type in the `blog` index. If you want to be
more specific you'll need to use the `query`. It also makes no effort to handle
ID collisions. The target index will remain valid but it's not easy to predict
which document will survive because the iteration order isn't well defined.

View File

@ -63,8 +63,7 @@ conflicting document was updated between the start of the `_update_by_query`
and the time when it attempted to update the document. This is fine because
that update will have picked up the online mapping update.
Back to the API format, you can limit `_update_by_query` to a single type. This
will only update `tweet` documents from the `twitter` index:
Back to the API format, this will update tweets from the `twitter` index:
[source,js]
--------------------------------------------------
@ -151,7 +150,7 @@ types at once, just like the search API:
[source,js]
--------------------------------------------------
POST twitter,blog/tweet,post/_update_by_query
POST twitter,blog/_doc,post/_update_by_query
--------------------------------------------------
// CONSOLE
// TEST[s/^/PUT twitter\nPUT blog\n/]

View File

@ -30,7 +30,7 @@ NOTE: The query being sent in the body must be nested in a `query` key, same as
the <<search-search,search api>> works
Both examples above do the same thing, which is count the number of
tweets from the twitter index for a certain user. The result is:
tweets from the `twitter` index for a certain user. The result is:
[source,js]
--------------------------------------------------