Browse Source

Revert "[DOCS] Update get data stream API response (#59197)" (#59227)

This reverts commit db3852898f01b9695f34fcf87e5630584effa9fd.
James Rodewig 5 years ago
parent
commit
678f9e3413

+ 20 - 35
docs/reference/data-streams/change-mappings-and-settings.asciidoc

@@ -84,8 +84,6 @@ PUT /_index_template/new_logs_data_stream
 
 PUT /_data_stream/logs
 
-POST /logs/_rollover/
-
 PUT /_data_stream/new_logs
 ----
 // TESTSETUP
@@ -567,46 +565,33 @@ data stream, including a list of its backing indices.
 ----
 GET /_data_stream/logs
 ----
+// TEST[skip: shard failures]
 
 The API returns the following response. Note the `indices` property contains an
-array of the stream's current backing indices. The first item in the array
-contains information about the stream's oldest backing index, `.ds-logs-000001`.
+array of the stream's current backing indices. The oldest backing index,
+`.ds-logs-000001`, is the first item in the array.
 
 [source,console-result]
 ----
-{
-  "data_streams": [
-    {
-      "name": "logs",
-      "timestamp_field": {
-        "name": "@timestamp",
-        "mapping": {
-          "type": "date"
-        }
+[
+  {
+    "name": "logs",
+    "timestamp_field": "@timestamp",
+    "indices": [
+      {
+        "index_name": ".ds-logs-000001",
+        "index_uuid": "DXAE-xcCQTKF93bMm9iawA"
       },
-      "indices": [
-        {
-          "index_name": ".ds-logs-000001",        <1>
-          "index_uuid": "Gpdiyq8sRuK9WuthvAdFbw"
-        },
-        {
-          "index_name": ".ds-logs-000002",
-          "index_uuid": "_eEfRrFHS9OyhqWntkgHAQ"
-        }
-      ],
-      "generation": 2,
-      "status": "GREEN",
-      "template": "logs_data_stream"
-    }
-  ]
-}
+      {
+        "index_name": ".ds-logs-000002",
+        "index_uuid": "Wzxq0VhsQKyPxHhaK3WYAg"
+      }
+    ],
+    "generation": 2
+  }
+]
 ----
-// TESTRESPONSE[s/"index_uuid": "Gpdiyq8sRuK9WuthvAdFbw"/"index_uuid": $body.data_streams.0.indices.0.index_uuid/]
-// TESTRESPONSE[s/"index_uuid": "_eEfRrFHS9OyhqWntkgHAQ"/"index_uuid": $body.data_streams.0.indices.1.index_uuid/]
-// TESTRESPONSE[s/"status": "GREEN"/"status": "YELLOW"/]
-
-<1> First item in the `indices` array for the `logs` data stream. This item
-contains information about the stream's oldest backing index, `.ds-logs-000001`.
+// TESTRESPONSE[skip:unable to assert responses with top level array]
 
 The following <<docs-reindex,reindex API>> request copies documents from
 `.ds-logs-000001` to the `new_logs` data stream. Note the request's `op_type` is

+ 65 - 55
docs/reference/data-streams/set-up-a-data-stream.asciidoc

@@ -276,6 +276,20 @@ PUT /_data_stream/logs_alt
 ====
 --
 
+////
+[source,console]
+----
+DELETE /_data_stream/logs
+
+DELETE /_data_stream/logs_alt
+
+DELETE /_index_template/logs_data_stream
+
+DELETE /_ilm/policy/logs_policy
+----
+// TEST[continued]
+////
+
 [discrete]
 [[get-info-about-a-data-stream]]
 === Get information about a data stream
@@ -283,77 +297,51 @@ PUT /_data_stream/logs_alt
 You can use the <<indices-get-data-stream,get data stream API>> to get
 information about one or more data streams, including:
 
-* The timestamp field and its mapping
+* The timestamp field
 * The current backing indices, which is returned as an array. The last item in
   the array contains information about the stream's current write index.
 * The current generation
-* The data stream's health status
-* The index template used to create the stream's backing indices
-* The current {ilm-init} lifecycle policy in the stream's matching index
-template
 
 This is also handy way to verify that a recently created data stream exists.
 
 .*Example*
 [%collapsible]
 ====
-The following get data stream API request retrieves information about the
-`logs` data stream.
+The following get data stream API request retrieves information about any data
+streams starting with `logs`.
 
-////
 [source,console]
 ----
-POST /logs/_rollover/
+GET /_data_stream/logs*
 ----
-// TEST[continued]
-////
+// TEST[skip: shard failures]
 
-[source,console]
-----
-GET /_data_stream/logs
-----
-// TEST[continued]
-
-The API returns the following response. Note the `indices` property contains an
-array of the stream's current backing indices. The last item in this array
-contains information about the stream's write index, `.ds-logs-000002`.
+The API returns the following response, which includes information about the
+`logs` data stream. Note the `indices` property contains an array of the
+stream's current backing indices. The last item in this array contains
+information for the `logs` stream's write index, `.ds-logs-000002`.
 
 [source,console-result]
 ----
-{
-  "data_streams": [
-    {
-      "name": "logs",
-      "timestamp_field": {
-        "name": "@timestamp",
-        "mapping": {
-          "type": "date"
-        }
+[
+  {
+    "name": "logs",
+    "timestamp_field": "@timestamp",
+    "indices": [
+      {
+        "index_name": ".ds-logs-000001",
+        "index_uuid": "DXAE-xcCQTKF93bMm9iawA"
       },
-      "indices": [
-        {
-          "index_name": ".ds-logs-000001",
-          "index_uuid": "krR78LfvTOe6gr5dj2_1xQ"
-        },
-        {
-          "index_name": ".ds-logs-000002",        <1>
-          "index_uuid": "C6LWyNJHQWmA08aQGvqRkA"
-        }
-      ],
-      "generation": 2,
-      "status": "GREEN",
-      "template": "logs_data_stream",
-      "ilm_policy": "logs_policy"
-    }
-  ]
-}
+      {
+        "index_name": ".ds-logs-000002",
+        "index_uuid": "Wzxq0VhsQKyPxHhaK3WYAg"
+      }
+    ],
+    "generation": 2
+  }
+]
 ----
-// TESTRESPONSE[s/"index_uuid": "krR78LfvTOe6gr5dj2_1xQ"/"index_uuid": $body.data_streams.0.indices.0.index_uuid/]
-// TESTRESPONSE[s/"index_uuid": "C6LWyNJHQWmA08aQGvqRkA"/"index_uuid": $body.data_streams.0.indices.1.index_uuid/]
-// TESTRESPONSE[s/"status": "GREEN"/"status": "YELLOW"/]
-
-<1> Last item in the `indices` array for the `logs` data stream. This item
-contains information about the stream's current write index, `.ds-logs-000002`.
+// TESTRESPONSE[skip:unable to assert responses with top level array]
 ====
 
 [discrete]
@@ -369,6 +357,30 @@ a data stream and its backing indices.
 The following delete data stream API request deletes the `logs` data stream. This
 request also deletes the stream's backing indices and any data they contain.
 
+////
+[source,console]
+----
+PUT /_index_template/logs_data_stream
+{
+  "index_patterns": [ "logs*" ],
+  "data_stream": {
+    "timestamp_field": "@timestamp"
+  },
+  "template": {
+    "mappings": {
+      "properties": {
+        "@timestamp": {
+          "type": "date"
+        }
+      }
+    }
+  }
+}
+
+PUT /_data_stream/logs
+----
+////
+
 [source,console]
 ----
 DELETE /_data_stream/logs
@@ -379,9 +391,7 @@ DELETE /_data_stream/logs
 ////
 [source,console]
 ----
-DELETE /_data_stream/*
-DELETE /_index_template/*
-DELETE /_ilm/policy/logs_policy
+DELETE /_index_template/logs_data_stream
 ----
 // TEST[continued]
 ////

+ 35 - 147
docs/reference/indices/get-data-stream.asciidoc

@@ -10,33 +10,9 @@ See <<get-info-about-a-data-stream>>.
 ////
 [source,console]
 ----
-PUT /_ilm/policy/my-lifecycle-policy
+PUT _index_template/template
 {
-  "policy": {
-    "phases": {
-      "hot": {
-        "actions": {
-          "rollover": {
-            "max_size": "25GB"
-          }
-        }
-      },
-      "delete": {
-        "min_age": "30d",
-        "actions": {
-          "delete": {}
-        }
-      }
-    }
-  }
-}
-
-PUT /_index_template/my-index-template
-{
-  "index_patterns": [ "my-data-stream*" ],
-  "data_stream": {
-    "timestamp_field": "@timestamp"
-  },
+  "index_patterns": ["my-data-stream*"],
   "template": {
     "mappings": {
       "properties": {
@@ -44,18 +20,14 @@ PUT /_index_template/my-index-template
           "type": "date"
         }
       }
-    },
-    "settings": {
-      "index.lifecycle.name": "my-lifecycle-policy"
     }
+  },
+  "data_stream": {
+    "timestamp_field": "@timestamp"
   }
 }
 
 PUT /_data_stream/my-data-stream
-
-POST /my-data-stream/_rollover
-
-PUT /_data_stream/my-data-stream_two
 ----
 // TESTSETUP
 ////
@@ -63,9 +35,8 @@ PUT /_data_stream/my-data-stream_two
 ////
 [source,console]
 ----
-DELETE /_data_stream/*
-DELETE /_index_template/*
-DELETE /_ilm/policy/my-lifecycle-policy
+DELETE /_data_stream/my-data-stream
+DELETE /_index_template/template
 ----
 // TEARDOWN
 ////
@@ -74,6 +45,7 @@ DELETE /_ilm/policy/my-lifecycle-policy
 ----
 GET /_data_stream/my-data-stream
 ----
+// TEST[skip_shard_failures]
 
 [[get-data-stream-api-request]]
 ==== {api-request-title}
@@ -92,34 +64,15 @@ Wildcard (`*`) expressions are supported.
 [[get-data-stream-api-response-body]]
 ==== {api-response-body-title}
 
-`data_streams`::
-(array of objects)
-Contains information about retrieved data streams.
-+
-.Properties of objects in `data_streams`
-[%collapsible%open]
-====
 `name`::
 (string)
 Name of the data stream.
 
 `timestamp_field`::
-(object)
-Contains information about the data stream's timestamp field.
-+
-.Properties of `timestamp_field`
-[%collapsible%open]
-=====
-`name`::
 (string)
 Name of the data stream's timestamp field. This field must be included in every
 document indexed to the data stream.
 
-`mapping`::
-(<<mapping,field mapping object>>)
-Field mapping for the data stream's timestamp field.
-=====
-
 `indices`::
 (array of objects)
 Array of objects containing information about the data stream's backing
@@ -130,7 +83,7 @@ The last item in this array contains information about the stream's current
 +
 .Properties of `indices` objects
 [%collapsible%open]
-=====
+====
 `index_name`::
 (string)
 Name of the backing index. For naming conventions, see
@@ -139,7 +92,7 @@ Name of the backing index. For naming conventions, see
 `index_uuid`::
 (string)
 Universally unique identifier (UUID) for the index.
-=====
+====
 
 `generation`::
 (integer)
@@ -147,47 +100,6 @@ Current <<data-streams-generation,generation>> for the data stream. This number
 acts as a cumulative count of the stream's backing indices, including
 deleted indices.
 
-`status`::
-(string)
-<<cluster-health,Health status>> of the data stream.
-+
-This health status is based on the state of the primary and replica shards of
-the stream's backing indices.
-+
-.Values for `status`
-[%collapsible%open]
-=====
-`green`:::
-All shards are assigned.
-
-`yellow`:::
-All primary shards are assigned, but one or more replica shards are
-unassigned.
-
-`red`:::
-One or more primary shards are unassigned, so some data is unavailable.
-=====
-
-`template`::
-(string)
-Name of the index template used to create the data stream's backing indices.
-+
-The template's index pattern must match the name of this data stream. See
-<<create-a-data-stream-template>>.
-
-`ilm_policy`::
-(string)
-Name of the current {ilm-init} lifecycle policy in the stream's matching index
-template. This lifecycle policy is set in the `index.lifecycle.name` setting.
-+
-If the template does not include a lifecycle policy, this property is not
-included in the response.
-+
-NOTE: A data stream's backing indices may be assigned different lifecycle
-policies. To retrieve the lifecycle policy for individual backing indices,
-use the <<indices-get-settings,get index settings API>>.
-====
-
 [[get-data-stream-api-example]]
 ==== {api-examples-title}
 
@@ -195,59 +107,35 @@ use the <<indices-get-settings,get index settings API>>.
 ----
 GET _data_stream/my-data-stream*
 ----
+// TEST[continued]
+// TEST[skip_shard_failures]
 
 The API returns the following response:
 
 [source,console-result]
 ----
-{
-  "data_streams": [
-    {
-      "name": "my-data-stream",
-      "timestamp_field": {
-        "name": "@timestamp",
-        "mapping": {
-          "type": "date"
-        }
-      },
-      "indices": [
-        {
-          "index_name": ".ds-my-data-stream-000001",
-          "index_uuid": "xCEhwsp8Tey0-FLNFYVwSg"
-        },
-        {
-          "index_name": ".ds-my-data-stream-000002",
-          "index_uuid": "PA_JquKGSiKcAKBA8DJ5gw"
-        }
-      ],
-      "generation": 2,
-      "status": "GREEN",
-      "template": "my-index-template",
-      "ilm_policy": "my-lifecycle-policy"
-    },
-    {
-      "name": "my-data-stream_two",
-      "timestamp_field": {
-        "name": "@timestamp",
-        "mapping": {
-          "type": "date"
-        }
+[
+  {
+    "name" : "my-data-stream",                      <1>
+    "timestamp_field" : "@timestamp",               <2>
+    "indices" : [                                   <3>
+      {
+        "index_name" : ".ds-my-data-stream-000001",
+        "index_uuid" : "DXAE-xcCQTKF93bMm9iawA"
       },
-      "indices": [
-        {
-          "index_name": ".ds-my-data-stream_two-000001",
-          "index_uuid": "3liBu2SYS5axasRt6fUIpA"
-        }
-      ],
-      "generation": 1,
-      "status": "YELLOW",
-      "template": "my-index-template",
-      "ilm_policy": "my-lifecycle-policy"
-    }
-  ]
-}
+      {
+        "index_name" : ".ds-my-data-stream-000002",
+        "index_uuid" : "Wzxq0VhsQKyPxHhaK3WYAg"
+      }
+    ],
+    "generation" : 2                                <4>
+  }
+]
 ----
-// TESTRESPONSE[s/"index_uuid": "xCEhwsp8Tey0-FLNFYVwSg"/"index_uuid": $body.data_streams.0.indices.0.index_uuid/]
-// TESTRESPONSE[s/"index_uuid": "PA_JquKGSiKcAKBA8DJ5gw"/"index_uuid": $body.data_streams.0.indices.1.index_uuid/]
-// TESTRESPONSE[s/"index_uuid": "3liBu2SYS5axasRt6fUIpA"/"index_uuid": $body.data_streams.1.indices.0.index_uuid/]
-// TESTRESPONSE[s/"status": "GREEN"/"status": "YELLOW"/]
+// TESTRESPONSE[skip:unable to assert responses with top level array]
+
+<1> Name of the data stream
+<2> The name of the timestamp field for the data stream
+<3> List of backing indices
+<4> Current generation for the data stream
+