Browse Source

[DOCS] Fix snippet tests for resolve API docs (#58908)

James Rodewig 5 years ago
parent
commit
7087a4546d
1 changed files with 75 additions and 30 deletions
  1. 75 30
      docs/reference/indices/resolve.asciidoc

+ 75 - 30
docs/reference/indices/resolve.asciidoc

@@ -8,6 +8,54 @@ Resolves the specified name(s) and/or wildcard expression(s) to indices, index
 aliases, and data streams. Multiple expressions and remote clusters are
 supported.
 
+////
+[source,console]
+----
+PUT /foo_closed
+
+POST /foo_closed/_close
+
+PUT /remotecluster-bar-01
+
+PUT /freeze-index
+
+POST /freeze-index/_freeze
+
+PUT /my-index
+
+PUT /freeze-index/_alias/f-alias
+
+PUT /my-index/_alias/f-alias
+
+PUT /_index_template/foo_data_stream
+{
+  "index_patterns": [ "foo" ],
+  "data_stream": {
+    "timestamp_field": "@timestamp"
+  },
+  "template": {
+    "mappings": {
+      "properties": {
+        "@timestamp": {
+          "type": "date"
+        }
+      }
+    }
+  }
+}
+
+PUT /_data_stream/foo
+----
+// TESTSETUP
+
+[source,console]
+----
+DELETE /_data_stream/*
+
+DELETE /_index_template/foo_data_stream
+----
+// TEARDOWN
+////
 
 [source,console]
 ----
@@ -42,66 +90,63 @@ Defaults to `open`.
 [[resolve-index-api-example]]
 ==== {api-examples-title}
 
-[[resolve-index-basic-example]]
-===== Basic example
-
 [source,console]
---------------------------------------------------
-GET /_resolve/index/f*,remoteCluster1:bar*
---------------------------------------------------
-// TEST[skip_shard_failures]
+----
+GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all
+----
+// TEST[continued]
+// TEST[s/remoteCluster1:/remotecluster-/]
 
 The API returns the following response:
 
 [source,console-result]
---------------------------------------------------
+----
 {
-  "indices" : [ <1>
+  "indices": [                                 <1>
     {
-      "name" : "foo_closed",
-      "attributes" : [
+      "name": "foo_closed",
+      "attributes": [
         "closed"
       ]
     },
     {
-      "name" : "remoteCluster1:bar-01",
-      "attributes" : [
+      "name": "freeze-index",
+      "aliases": [
+        "f-alias"
+      ],
+      "attributes": [
+        "frozen",
         "open"
       ]
     },
     {
-      "name" : "freeze-index",
-      "aliases" : [
-        "f-alias"
-      ],
-      "attributes" : [
-        "open",
-        "frozen"
+      "name": "remoteCluster1:bar-01",
+      "attributes": [
+        "open"
       ]
     }
   ],
-  "aliases" : [ <2>
+  "aliases": [                                 <2>
     {
-      "name" : "f-alias",
-      "indices" : [
+      "name": "f-alias",
+      "indices": [
         "freeze-index",
         "my-index"
       ]
     }
   ],
-  "data_streams" : [ <3>
+  "data_streams": [                            <3>
     {
-      "name" : "foo",
-      "backing_indices" : [
+      "name": "foo",
+      "backing_indices": [
         ".ds-foo-000001"
       ],
-      "timestamp_field" : "@timestamp"
+      "timestamp_field": "@timestamp"
     }
   ]
 }
---------------------------------------------------
-// TESTRESPONSE[skip:unable to assert responses with top level array]
-
+----
+// TESTRESPONSE[s/remoteCluster1:/remotecluster-/]
 <1> All indices matching the supplied names or expressions
 <2> All aliases matching the supplied names or expressions
 <3> All data streams matching the supplied names or expressions