Adding examples

Author: masseyke

output/schema/schema.json

@@ -0,0 +1,32 @@
+summary: Get data stream settings on a data stream
+description: >
+  This is a response to `GET /_data_stream/my-data-stream/_settings` where my-data-stream that has two settings set. The
+  `effective_settings` field shows additional settings that are pulled from its template.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "data_streams": [
+      {
+        "name": "my-data-stream",
+        "settings": {
+          "index": {
+            "lifecycle": {
+              "name": "new-test-policy"
+            },
+            "number_of_shards": "11"
+          }
+        },
+        "effective_settings": {
+          "index": {
+            "lifecycle": {
+              "name": "new-test-policy"
+            },
+            "mode": "standard",
+            "number_of_shards": "11",
+            "number_of_replicas": "0"
+          }
+        }
+      }
+    ]
+  }

specification/indices/get_data_stream_settings/examples/200_response/IndicesGetDataStreamSettingsResponseExample1.yaml

@@ -0,0 +1,42 @@
+summary: Change data stream settings on a data stream
+description: >
+  This shows a response to `PUT /_data_stream/my-data-stream/_settings` when two settings are successfully updated on
+  the data stream. In this case, `index.number_of_shards` is only applied to the data stream -- it will be applied to
+  the write index on rollover. The setting `index.lifecycle.name` is applied to the data stream and all backing indices.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "data_streams": [
+      {
+        "name": "my-data-stream",
+        "applied_to_data_stream": true,
+        "settings": {
+          "index": {
+            "lifecycle": {
+              "name": "new-test-policy"
+            },
+            "number_of_shards": "11"
+          }
+        },
+        "effective_settings": {
+          "index": {
+            "lifecycle": {
+              "name": "new-test-policy"
+            },
+            "mode": "standard",
+            "number_of_shards": "11",
+            "number_of_replicas": "0"
+          }
+        },
+        "index_settings_results": {
+          "applied_to_data_stream_only": [
+            "index.number_of_shards"
+          ],
+          "applied_to_data_stream_and_backing_indices": [
+            "index.lifecycle.name"
+          ]
+        }
+      }
+    ]
+  }

specification/indices/put_data_stream_settings/examples/200_response/IndicesPutDataStreamSettingsResponseExample1.yaml

@@ -0,0 +1,48 @@
+summary: Change data stream settings on a data stream that has an index with a metadata block
+description: >
+  This shows a response to `PUT /_data_stream/my-data-stream/_settings` when a setting is successfully applied to the
+  data stream, but one of the backing indices, `.ds-my-data-stream-2025.05.28-000001`, has a write block. The response
+  reports that the setting was not successfully applied to that index.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "data_streams": [
+      {
+        "name": "my-data-stream",
+        "applied_to_data_stream": true,
+        "settings": {
+          "index": {
+            "lifecycle": {
+              "name": "new-test-policy"
+            },
+            "number_of_shards": "11"
+          }
+        },
+        "effective_settings": {
+          "index": {
+            "lifecycle": {
+              "name": "new-test-policy"
+            },
+            "mode": "standard",
+            "number_of_shards": "11",
+            "number_of_replicas": "0"
+          }
+        },
+        "index_settings_results": {
+          "applied_to_data_stream_only": [
+            "index.number_of_shards"
+          ],
+          "applied_to_data_stream_and_backing_indices": [
+            "index.lifecycle.name"
+          ],
+          "errors": [
+            {
+              "index": ".ds-my-data-stream-2025.05.28-000001",
+              "error": "index [.ds-my-data-stream-2025.05.28-000001] blocked by: [FORBIDDEN/9/index metadata (api)];"
+            }
+          ]
+        }
+      }
+    ]
+  }

specification/indices/put_data_stream_settings/examples/200_response/IndicesPutDataStreamSettingsResponseExample2.yaml

@@ -0,0 +1,22 @@
+summary: Attempt to change a data stream setting that is not allowed
+description: >
+  This shows a response to `PUT /_data_stream/my-data-stream/_settings` when a user attempts to set a setting that is
+  not allowed on a data stream. As a result, no change was applied to the data stream.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "data_streams": [
+      {
+        "name": "my-data-stream",
+        "applied_to_data_stream": false,
+        "error": "Cannot set the following settings on a data stream: [index.number_of_replicas]",
+        "settings": {},
+        "effective_settings": {},
+        "index_settings_results": {
+          "applied_to_data_stream_only": [],
+          "applied_to_data_stream_and_backing_indices": []
+        }
+      }
+    ]
+  }

specification/indices/put_data_stream_settings/examples/200_response/IndicesPutDataStreamSettingsResponseExample3.yaml

@@ -0,0 +1,10 @@
+summary: Change a data stream setting
+# method_request: PUT /_data_stream/my-data-stream/_settings
+description: >
+  This is a request to change two settings on a data stream.
+# type: request
+value: |-
+  {
+    "index.lifecycle.name" : "new-test-policy",
+    "index.number_of_shards": 11
+  }