Skip to content

[Docs] Convert more doc snippets #26404

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 2 commits into from
Aug 30, 2017
Merged

[Docs] Convert more doc snippets #26404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a91a0cd
[Docs] Convert more doc snippets
tlrx Aug 28, 2017
3c88cec
Apply feedback
tlrx Aug 29, 2017
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
9 changes: 0 additions & 9 deletions docs/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,6 @@ buildRestTests.expectedUnconvertedCandidates = [
'reference/aggregations/matrix/stats-aggregation.asciidoc',
'reference/aggregations/metrics/tophits-aggregation.asciidoc',
'reference/cluster/allocation-explain.asciidoc',
'reference/cluster/pending.asciidoc',
'reference/cluster/tasks.asciidoc',
'reference/docs/delete-by-query.asciidoc',
'reference/docs/reindex.asciidoc',
'reference/docs/update-by-query.asciidoc',
'reference/index-modules/similarity.asciidoc',
'reference/index-modules/store.asciidoc',
'reference/index-modules/translog.asciidoc',
'reference/search/profile.asciidoc',
]

integTestCluster {
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cluster/pending.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ might be reported by both task api and pending cluster tasks API.

[source,js]
--------------------------------------------------
$ curl -XGET 'http://localhost:9200/_cluster/pending_tasks'
GET /_cluster/pending_tasks
--------------------------------------------------
// CONSOLE

Usually this will return an empty list as cluster-level changes are usually
fast. However if there are tasks queued up, the output will look something
Expand Down Expand Up @@ -47,3 +48,5 @@ like this:
]
}
--------------------------------------------------
// NOTCONSOLE
Copy link
Member

@nik9000 nik9000 Aug 28, 2017

Choose a reason for hiding this comment

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

I'd originally thought of // NOTCONSOLE as only for requests that looked like they should be converted to // CONSOLE but can't for some reason, like maybe we're demonstrating how to use curl in the _bulk API.

While the name // NOTCONSOLE isn't really right for this the idea makes sense. We can't assert anything about this response.

So I'm 👍 on doing this here.

// We can't test tasks output
5 changes: 4 additions & 1 deletion docs/reference/cluster/tasks.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ The result will look similar to the following:
}
}
--------------------------------------------------
// NOTCONSOLE
// We can't test tasks output

It is also possible to retrieve information for a particular task:

Expand Down Expand Up @@ -117,6 +119,8 @@ might look like:
}
}
--------------------------------------------------
// NOTCONSOLE
// We can't test tasks output

The new `description` field contains human readable text that identifies the
particular request that the task is performing such as identifying the search
Expand Down Expand Up @@ -180,7 +184,6 @@ POST _tasks/_cancel?nodes=nodeId1,nodeId2&actions=*reindex
--------------------------------------------------
// CONSOLE


[float]
=== Task Grouping

Expand Down
37 changes: 33 additions & 4 deletions docs/reference/docs/delete-by-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,20 +187,47 @@ starting the next set. This is "bursty" instead of "smooth". The default is `-1`
[float]
=== Response body

//////////////////////////

[source,js]
--------------------------------------------------
POST /twitter/_delete_by_query
{
"query": { <1>
"match": {
"message": "some message"
}
}
}
--------------------------------------------------
// CONSOLE
// TEST[setup:big_twitter]

//////////////////////////

The JSON response looks like this:

[source,js]
--------------------------------------------------
{
"took" : 639,
"deleted": 0,
"took" : 147,
"timed_out": false,
"deleted": 119,
"batches": 1,
"version_conflicts": 2,
"retries": 0,
"version_conflicts": 0,
"noops": 0,
"retries": {
"bulk": 0,
"search": 0
},
"throttled_millis": 0,
"requests_per_second": -1.0,
"throttled_until_millis": 0,
"total": 119,
"failures" : [ ]
}
--------------------------------------------------
// TESTRESPONSE[s/: [0-9]+/: $body.$_path/]

`took`::

Expand Down Expand Up @@ -285,6 +312,8 @@ The responses looks like:
}
}
--------------------------------------------------
// NOTCONSOLE
// We can't test tasks output

<1> this object contains the actual status. It is just like the response json
with the important addition of the `total` field. `total` is the total number
Expand Down
33 changes: 30 additions & 3 deletions docs/reference/docs/reindex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,24 +558,49 @@ starting the next set. This is "bursty" instead of "smooth". The default is `-1`
[[docs-reindex-response-body]]
=== Response body

//////////////////////////
[source,js]
--------------------------------------------------
POST /_reindex?wait_for_completion
{
"source": {
"index": "twitter"
},
"dest": {
"index": "new_twitter"
}
}
--------------------------------------------------
// CONSOLE
// TEST[setup:twitter]

//////////////////////////

The JSON response looks like this:

[source,js]
--------------------------------------------------
{
"took" : 639,
"took": 639,
"timed_out": false,
"total": 5,
"updated": 0,
"created": 123,
"deleted": 0,
"batches": 1,
"noops": 0,
"version_conflicts": 2,
"retries": {
"bulk": 0,
"search": 0
}
},
"throttled_millis": 0,
"failures" : [ ]
"requests_per_second": 1,
"throttled_until_millis": 0,
"failures": [ ]
}
--------------------------------------------------
// TESTRESPONSE[s/: [0-9]+/: $body.$_path/]

`took`::

Expand Down Expand Up @@ -667,6 +692,8 @@ The responses looks like:
}
}
--------------------------------------------------
// NOTCONSOLE
// We can't test tasks output

<1> this object contains the actual status. It is just like the response json
with the important addition of the `total` field. `total` is the total number
Expand Down
27 changes: 23 additions & 4 deletions docs/reference/docs/update-by-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,23 +245,40 @@ starting the next set. This is "bursty" instead of "smooth". The default is `-1`
[[docs-update-by-query-response-body]]
=== Response body

//////////////////////////
[source,js]
--------------------------------------------------
POST /twitter/_update_by_query?conflicts=proceed
--------------------------------------------------
// CONSOLE
// TEST[setup:twitter]

//////////////////////////

The JSON response looks like this:

[source,js]
--------------------------------------------------
{
"took" : 639,
"updated": 0,
"took" : 147,
"timed_out": false,
"updated": 5,
"deleted": 0,
"batches": 1,
"version_conflicts": 2,
"version_conflicts": 0,
"noops": 0,
"retries": {
"bulk": 0,
"search": 0
}
},
"throttled_millis": 0,
"requests_per_second": -1.0,
"throttled_until_millis": 0,
"total": 5,
"failures" : [ ]
}
--------------------------------------------------
// TESTRESPONSE[s/"took" : 147/"took" : "$body.took"/]

`took`::

Expand Down Expand Up @@ -350,6 +367,8 @@ The responses looks like:
}
}
--------------------------------------------------
// NOTCONSOLE
// We can't test tasks output

<1> this object contains the actual status. It is just like the response json
with the important addition of the `total` field. `total` is the total number
Expand Down
Loading