[Docs] Convert more doc snippets (#26359)

This commit converts some remaining doc snippets so that they are now
testable.

Author: tlrx

buildSrc/src/main/groovy/org/elasticsearch/gradle/doc/RestTestsFromSnippetsTask.groovy

@@ -93,7 +93,7 @@ public class RestTestsFromSnippetsTask extends SnippetsTask {
          *
          * `sh` snippets that contain `curl` almost always should be marked
          * with `// CONSOLE`. In the exceptionally rare cases where they are
-         * not communicating with Elasticsearch, like the xamples in the ec2
+         * not communicating with Elasticsearch, like the examples in the ec2
          * and gce discovery plugins, the snippets should be marked
          * `// NOTCONSOLE`. */
         return snippet.language == 'js' || snippet.curl

docs/build.gradle

@@ -32,20 +32,14 @@ buildRestTests.expectedUnconvertedCandidates = [
   'reference/aggregations/matrix/stats-aggregation.asciidoc',
   'reference/aggregations/metrics/tophits-aggregation.asciidoc',
   'reference/cluster/allocation-explain.asciidoc',
-  'reference/cluster/nodes-info.asciidoc',
   'reference/cluster/pending.asciidoc',
-  'reference/cluster/state.asciidoc',
-  'reference/cluster/stats.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/indices/recovery.asciidoc',
-  'reference/indices/segments.asciidoc',
-  'reference/indices/shard-stores.asciidoc',
   'reference/migration/migrate_6_0/scripting.asciidoc',
   'reference/search/profile.asciidoc',
 ]
@@ -542,4 +536,4 @@ for (int i = 0; i < 5; i++) {
   buildRestTests.setups['iprange'] += """
             {"index":{}}
             {"ip": "12.0.0.$i"}"""
-}
+}

docs/reference/cluster/nodes-info.asciidoc

@@ -6,9 +6,10 @@ the cluster nodes information.
 
 [source,js]
 --------------------------------------------------
-curl -XGET 'http://localhost:9200/_nodes'
-curl -XGET 'http://localhost:9200/_nodes/nodeId1,nodeId2'
+GET /_nodes
+GET /_nodes/nodeId1,nodeId2
 --------------------------------------------------
+// CONSOLE
 
 The first command retrieves information of all the nodes in the cluster.
 The second command selectively retrieves nodes information of only
@@ -52,14 +53,22 @@ It also allows to get only information on `settings`, `os`, `process`, `jvm`,
 
 [source,js]
 --------------------------------------------------
-curl -XGET 'http://localhost:9200/_nodes/process'
-curl -XGET 'http://localhost:9200/_nodes/_all/process'
-curl -XGET 'http://localhost:9200/_nodes/nodeId1,nodeId2/jvm,process'
+# return just process
+GET /_nodes/process
+
+# same as above
+GET /_nodes/_all/process
+
+# return just jvm and process of only nodeId1 and nodeId2
+GET /_nodes/nodeId1,nodeId2/jvm,process
+
 # same as above
-curl -XGET 'http://localhost:9200/_nodes/nodeId1,nodeId2/info/jvm,process'
+GET /_nodes/nodeId1,nodeId2/info/jvm,process
 
-curl -XGET 'http://localhost:9200/_nodes/nodeId1,nodeId2/_all
+# return all the information of only nodeId1 and nodeId2
+GET /_nodes/nodeId1,nodeId2/_all
 --------------------------------------------------
+// CONSOLE
 
 The `_all` flag can be set to return all the information - or you can simply omit it.
 
@@ -110,23 +119,36 @@ the current running process:
 [[plugins-info]]
 ==== Plugins information
 
-`plugins` - if set, the result will contain details about the installed plugins
- per node:
+`plugins` - if set, the result will contain details about the installed plugins and modules per node:
 
-* `name`: plugin name
-* `version`: version of Elasticsearch the plugin was built for
-* `description`: short description of the plugin's purpose
-* `classname`: fully-qualified class name of the plugin's entry point
-* `has_native_controller`: whether or not the plugin has a native controller process
+[source,js]
+--------------------------------------------------
+GET /_nodes/plugins
+--------------------------------------------------
+// CONSOLE
+// TEST[setup:node]
 
 The result will look similar to:
 
 [source,js]
 --------------------------------------------------
 {
+  "_nodes": ...
   "cluster_name": "elasticsearch",
   "nodes": {
-    "O70_wBv6S9aPPcAKdSUBtw": {
+    "USpTGYaBSIKbgSUJR2Z9lg": {
+      "name": "node-0",
+      "transport_address": "192.168.17:9300",
+      "host": "node-0.elastic.co",
+      "ip": "192.168.17",
+      "version": "{version}",
+      "build_hash": "587409e",
+      "roles": [
+        "master",
+        "data",
+        "ingest"
+      ],
+      "attributes": {},
       "plugins": [
         {
           "name": "analysis-icu",
@@ -149,11 +171,41 @@ The result will look similar to:
           "classname": "org.elasticsearch.ingest.useragent.IngestUserAgentPlugin",
           "has_native_controller": false
         }
+      ],
+      "modules": [
+        {
+          "name": "lang-painless",
+          "version": "{version}",
+          "description": "An easy, safe and fast scripting language for Elasticsearch",
+          "classname": "org.elasticsearch.painless.PainlessPlugin",
+          "has_native_controller": false
+        }
       ]
     }
   }
 }
 --------------------------------------------------
+// TESTRESPONSE[s/"_nodes": \.\.\./"_nodes": $body.$_path,/]
+// TESTRESPONSE[s/"elasticsearch"/$body.cluster_name/]
+// TESTRESPONSE[s/"USpTGYaBSIKbgSUJR2Z9lg"/\$node_name/]
+// TESTRESPONSE[s/"name": "node-0"/"name": $body.$_path/]
+// TESTRESPONSE[s/"transport_address": "192.168.17:9300"/"transport_address": $body.$_path/]
+// TESTRESPONSE[s/"host": "node-0.elastic.co"/"host": $body.$_path/]
+// TESTRESPONSE[s/"ip": "192.168.17"/"ip": $body.$_path/]
+// TESTRESPONSE[s/"build_hash": "587409e"/"build_hash": $body.$_path/]
+// TESTRESPONSE[s/"roles": \[[^\]]*\]/"roles": $body.$_path/]
+// TESTRESPONSE[s/"attributes": \{[^\}]*\}/"attributes": $body.$_path/]
+// TESTRESPONSE[s/"plugins": \[[^\]]*\]/"plugins": $body.$_path/]
+// TESTRESPONSE[s/"modules": \[[^\]]*\]/"modules": $body.$_path/]
+
+The following information are available for each plugin and module:
+
+* `name`: plugin name
+* `version`: version of Elasticsearch the plugin was built for
+* `description`: short description of the plugin's purpose
+* `classname`: fully-qualified class name of the plugin's entry point
+* `has_native_controller`: whether or not the plugin has a native controller process
+
 
 [float]
 [[ingest-info]]
@@ -162,16 +214,30 @@ The result will look similar to:
 `ingest` - if set, the result will contain details about the available
 processors per node:
 
-* `type`: the processor type
+[source,js]
+--------------------------------------------------
+GET /_nodes/ingest
+--------------------------------------------------
+// CONSOLE
+// TEST[setup:node]
 
 The result will look similar to:
 
 [source,js]
 --------------------------------------------------
 {
+  "_nodes": ...
   "cluster_name": "elasticsearch",
   "nodes": {
-    "O70_wBv6S9aPPcAKdSUBtw": {
+    "USpTGYaBSIKbgSUJR2Z9lg": {
+      "name": "node-0",
+      "transport_address": "192.168.17:9300",
+      "host": "node-0.elastic.co",
+      "ip": "192.168.17",
+      "version": "{version}",
+      "build_hash": "587409e",
+      "roles": [],
+      "attributes": {},
       "ingest": {
         "processors": [
           {
@@ -221,4 +287,19 @@ The result will look similar to:
     }
   }
 }
---------------------------------------------------
+--------------------------------------------------
+// TESTRESPONSE[s/"_nodes": \.\.\./"_nodes": $body.$_path,/]
+// TESTRESPONSE[s/"elasticsearch"/$body.cluster_name/]
+// TESTRESPONSE[s/"USpTGYaBSIKbgSUJR2Z9lg"/\$node_name/]
+// TESTRESPONSE[s/"name": "node-0"/"name": $body.$_path/]
+// TESTRESPONSE[s/"transport_address": "192.168.17:9300"/"transport_address": $body.$_path/]
+// TESTRESPONSE[s/"host": "node-0.elastic.co"/"host": $body.$_path/]
+// TESTRESPONSE[s/"ip": "192.168.17"/"ip": $body.$_path/]
+// TESTRESPONSE[s/"build_hash": "587409e"/"build_hash": $body.$_path/]
+// TESTRESPONSE[s/"roles": \[[^\]]*\]/"roles": $body.$_path/]
+// TESTRESPONSE[s/"attributes": \{[^\}]*\}/"attributes": $body.$_path/]
+// TESTRESPONSE[s/"processors": \[[^\]]*\]/"processors": $body.$_path/]
+
+The following information are available for each ingest processor:
+
+* `type`: the processor type

docs/reference/cluster/state.asciidoc

@@ -6,8 +6,9 @@ the whole cluster.
 
 [source,js]
 --------------------------------------------------
-$ curl -XGET 'http://localhost:9200/_cluster/state'
+GET /_cluster/state
 --------------------------------------------------
+// CONSOLE
 
 The response provides the cluster name, the total compressed size
 of the cluster state (its size when serialized for transmission over
@@ -27,8 +28,9 @@ it is possible to filter the cluster state response specifying the parts in the
 
 [source,js]
 --------------------------------------------------
-$ curl -XGET 'http://localhost:9200/_cluster/state/{metrics}/{indices}'
+GET /_cluster/state/{metrics}/{indices}
 --------------------------------------------------
+// CONSOLE
 
 `metrics` can be a comma-separated list of
 
@@ -50,17 +52,27 @@ $ curl -XGET 'http://localhost:9200/_cluster/state/{metrics}/{indices}'
 `blocks`::
     Shows the `blocks` part of the response
 
-A couple of example calls:
+The following example returns only `metadata` and `routing_table` data for the `foo` and `bar` indices:
 
 [source,js]
 --------------------------------------------------
-# return only metadata and routing_table data for specified indices
-$ curl -XGET 'http://localhost:9200/_cluster/state/metadata,routing_table/foo,bar'
+GET /_cluster/state/metadata,routing_table/foo,bar
+--------------------------------------------------
+// CONSOLE
+
+The next example returns everything for the `foo` and `bar` indices:
 
-# return everything for these two indices
-$ curl -XGET 'http://localhost:9200/_cluster/state/_all/foo,bar'
+[source,js]
+--------------------------------------------------
+GET /_cluster/state/_all/foo,bar
+--------------------------------------------------
+// CONSOLE
 
-# Return only blocks data
-$ curl -XGET 'http://localhost:9200/_cluster/state/blocks'
+And this example return only `blocks` data:
+[source,js]
 --------------------------------------------------
+GET /_cluster/state/blocks
+--------------------------------------------------
+// CONSOLE
+
 

docs/reference/cluster/stats.asciidoc

@@ -8,21 +8,28 @@ versions, memory usage, cpu and installed plugins).
 
 [source,js]
 --------------------------------------------------
-curl -XGET 'http://localhost:9200/_cluster/stats?human&pretty'
+GET /_cluster/stats?human&pretty
 --------------------------------------------------
+// CONSOLE
+// TEST[setup:twitter]
 
 Will return, for example:
 ["source","js",subs="attributes,callouts"]
 --------------------------------------------------
 {
-   "timestamp": 1459427693515,
+   "_nodes" : {
+      "total" : 1,
+      "successful" : 1,
+      "failed" : 0
+   },
    "cluster_name": "elasticsearch",
+   "timestamp": 1459427693515,
    "status": "green",
    "indices": {
-      "count": 2,
+      "count": 1,
       "shards": {
-         "total": 10,
-         "primaries": 10,
+         "total": 5,
+         "primaries": 5,
          "replication": 0,
          "index": {
             "shards": {
@@ -48,9 +55,7 @@ Will return, for example:
       },
       "store": {
          "size": "16.2kb",
-         "size_in_bytes": 16684,
-         "throttle_time": "0s",
-         "throttle_time_in_millis": 0
+         "size_in_bytes": 16684
       },
       "fielddata": {
          "memory_size": "0b",
@@ -83,6 +88,8 @@ Will return, for example:
          "term_vectors_memory_in_bytes": 0,
          "norms_memory": "384b",
          "norms_memory_in_bytes": 384,
+         "points_memory" : "0b",
+         "points_memory_in_bytes" : 0,
          "doc_values_memory": "744b",
          "doc_values_memory_in_bytes": 744,
          "index_writer_memory": "0b",
@@ -91,10 +98,8 @@ Will return, for example:
          "version_map_memory_in_bytes": 0,
          "fixed_bit_set": "0b",
          "fixed_bit_set_memory_in_bytes": 0,
+         "max_unsafe_auto_id_timestamp" : -9223372036854775808,
          "file_sizes": {}
-      },
-      "percolator": {
-         "num_queries": 0
       }
    },
    "nodes": {
@@ -188,8 +193,22 @@ Will return, for example:
           "classname": "org.elasticsearch.ingest.useragent.IngestUserAgentPlugin",
           "has_native_controller": false
         }
-      ]
+      ],
+      "network_types" : {
+         "transport_types" : {
+            "netty4" : 1
+         },
+         "http_types" : {
+            "netty4" : 1
+         }
+      }
    }
 }
 --------------------------------------------------
-
+// TESTRESPONSE[s/"plugins": \[[^\]]*\]/"plugins": $body.$_path/]
+// TESTRESPONSE[s/: (\-)?[0-9]+/: $body.$_path/]
+// TESTRESPONSE[s/: "[^"]*"/: $body.$_path/]
+////
+The TESTRESPONSE above replace all the fields values by the expected ones in the test,
+because we don't really care about the field values but we want to check the fields names.
+////