Skip to content

Edits to text in Get API doc #39012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2019
Merged

Edits to text in Get API doc #39012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/reference/docs/get.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The result of the above get operation is:
--------------------------------------------------
// TESTRESPONSE[s/"_seq_no" : \d+/"_seq_no" : $body._seq_no/ s/"_primary_term" : 1/"_primary_term" : $body._primary_term/]

The above result includes the `_index`, `_type`, `_id` and `_version`
The above result includes the `_index`, `_type`, `_id`, and `_version`
of the document we wish to retrieve, including the actual `_source`
of the document if it could be found (as indicated by the `found`
field in the response).
Expand Down Expand Up @@ -76,7 +76,7 @@ GET twitter/_doc/0?_source=false
// TEST[setup:twitter]

If you only need one or two fields from the complete `_source`, you can use the `_source_includes`
& `_source_excludes` parameters to include or filter out that parts you need. This can be especially helpful
and `_source_excludes` parameters to include or filter out the parts you need. This can be especially helpful
with large documents where partial retrieval can save on network overhead. Both parameters take a comma separated list
of fields or wildcard expressions. Example:

Expand Down Expand Up @@ -140,7 +140,7 @@ PUT twitter/_doc/1
// CONSOLE
// TEST[continued]

... and try to retrieve it:
And then try to retrieve it:

[source,js]
--------------------------------------------------
Expand Down Expand Up @@ -238,7 +238,7 @@ You can also use the same source filtering parameters to control which parts of

[source,js]
--------------------------------------------------
GET twitter/_doc/1/_source?_source_includes=*.id&_source_excludes=entities'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK to delete this stray single quote?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that looks ok to me.

GET twitter/_doc/1/_source?_source_includes=*.id&_source_excludes=entities
--------------------------------------------------
// CONSOLE
// TEST[continued]
Expand Down Expand Up @@ -268,7 +268,7 @@ GET twitter/_doc/2?routing=user1
// TEST[continued]

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
user. Note that issuing a get without the correct routing will cause the
document not to be fetched.

[float]
Expand Down Expand Up @@ -313,7 +313,7 @@ indexing).
The get operation gets hashed into a specific shard id. It then gets
redirected to one of the replicas within that shard id and returns the
result. The replicas are the primary shard and its replicas within that
shard id group. This means that the more replicas we will have, the
shard id group. This means that the more replicas we have, the
better GET scaling we will have.


Expand Down