Adds index API requests and responses - part 1.

specification/indices/create/indicesCreateRequestExample1.yaml

@@ -0,0 +1,6 @@
+summary: Creates an index.
+method_request: PUT /my-index-000001
+description: This request specifies the `number_of_shards` and `number_of_replicas`.
+type: request
+value: "{\n \"settings\": {\n \"number_of_shards\": 3,\n \"number_of_replicas\"\
+ : 2\n }\n}"

specification/indices/create/indicesCreateRequestExample2.yaml

@@ -0,0 +1,6 @@
+summary: Creates an index with mapping.
+method_request: PUT /test
+description: You can provide mapping definitions in the create index API requests.
+type: request
+value: "{\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n\
+ \ \"properties\": {\n \"field1\": { \"type\": \"text\" }\n }\n }\n}"

specification/indices/data_streams_stats/indicesDataStreamStatsResponseExample1.yaml

@@ -0,0 +1,12 @@
+summary: A successful response for retrieving statistics for a data stream.
+description: ''
+type: response
+response_code: 200
+value: "{\n \"_shards\": {\n \"total\": 10,\n \"successful\": 5,\n \"failed\"\
+ : 0\n },\n \"data_stream_count\": 2,\n \"backing_indices\": 5,\n \"total_store_size\"\
+ : \"7kb\",\n \"total_store_size_bytes\": 7268,\n \"data_streams\": [\n {\n\
+ \ \"data_stream\": \"my-data-stream\",\n \"backing_indices\": 3,\n \
+ \ \"store_size\": \"3.7kb\",\n \"store_size_bytes\": 3772,\n \"maximum_timestamp\"\
+ : 1607512028000\n },\n {\n \"data_stream\": \"my-data-stream-two\",\n\
+ \ \"backing_indices\": 2,\n \"store_size\": \"3.4kb\",\n \"store_size_bytes\"\
+ : 3496,\n \"maximum_timestamp\": 1607425567000\n }\n ]\n}"

specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleResponseExample1.yaml

@@ -0,0 +1,5 @@
+summary: A successful response for deleting a data stream lifecycle.
+description: ''
+type: response
+response_code: 200
+value: "{\n \"acknowledged\": true\n}"

specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml

@@ -0,0 +1,10 @@
+summary: A successful response for retrieving data stream lifecycle status for a data stream backing index.
+description: ''
+type: response
+response_code: 200
+value: "{\n \"indices\": {\n \".ds-metrics-2023.03.22-000001\": {\n \"index\"\
+ \ : \".ds-metrics-2023.03.22-000001\",\n \"managed_by_lifecycle\" : true,\n\
+ \ \"index_creation_date_millis\" : 1679475563571,\n \"time_since_index_creation\"\
+ \ : \"843ms\",\n \"rollover_date_millis\" : 1679475564293,\n \"time_since_rollover\"\
+ \ : \"121ms\",\n \"lifecycle\" : { },\n \"generation_time\" : \"121ms\"\
+ \n }\n}"

specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponseExample1.yaml

@@ -0,0 +1,9 @@
+summary: A successful response of getting the lifecycle of a set of data streams.
+description: ''
+type: response
+response_code: 200
+value: "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream-1\",\n \
+ \ \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\":\
+ \ \"7d\"\n }\n },\n {\n \"name\": \"my-data-stream-2\",\n \"\
+ lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n\
+ \ }\n }\n ]\n}"

specification/indices/get_data_stream/indicesGetDataStreamResponseExample1.yaml

@@ -0,0 +1,31 @@
+summary: A successful response for retrieving information about a data stream.
+description: ''
+type: response
+response_code: 200
+value: "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream\",\n \
+ \ \"timestamp_field\": {\n \"name\": \"@timestamp\"\n },\n \"\
+ indices\": [\n {\n \"index_name\": \".ds-my-data-stream-2099.03.07-000001\"\
+ ,\n \"index_uuid\": \"xCEhwsp8Tey0-FLNFYVwSg\",\n \"prefer_ilm\"\
+ : true,\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\"\
+ : \"Index Lifecycle Management\"\n },\n {\n \"index_name\"\
+ : \".ds-my-data-stream-2099.03.08-000002\",\n \"index_uuid\": \"PA_JquKGSiKcAKBA8DJ5gw\"\
+ ,\n \"prefer_ilm\": true,\n \"ilm_policy\": \"my-lifecycle-policy\"\
+ ,\n \"managed_by\": \"Index Lifecycle Management\"\n }\n ],\n\
+ \ \"generation\": 2,\n \"_meta\": {\n \"my-meta-field\": \"foo\"\
+ \n },\n \"status\": \"GREEN\",\n \"next_generation_managed_by\":\
+ \ \"Index Lifecycle Management\",\n \"prefer_ilm\": true,\n \"template\"\
+ : \"my-index-template\",\n \"ilm_policy\": \"my-lifecycle-policy\",\n \
+ \ \"hidden\": false,\n \"system\": false,\n \"allow_custom_routing\":\
+ \ false,\n \"replicated\": false,\n \"rollover_on_write\": false\n \
+ \ },\n {\n \"name\": \"my-data-stream-two\",\n \"timestamp_field\"\
+ : {\n \"name\": \"@timestamp\"\n },\n \"indices\": [\n {\n\
+ \ \"index_name\": \".ds-my-data-stream-two-2099.03.08-000001\",\n \
+ \ \"index_uuid\": \"3liBu2SYS5axasRt6fUIpA\",\n \"prefer_ilm\": true,\n\
+ \ \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\": \"\
+ Index Lifecycle Management\"\n }\n ],\n \"generation\": 1,\n \
+ \ \"_meta\": {\n \"my-meta-field\": \"foo\"\n },\n \"status\"\
+ : \"YELLOW\",\n \"next_generation_managed_by\": \"Index Lifecycle Management\"\
+ ,\n \"prefer_ilm\": true,\n \"template\": \"my-index-template\",\n \
+ \ \"ilm_policy\": \"my-lifecycle-policy\",\n \"hidden\": false,\n \"\
+ system\": false,\n \"allow_custom_routing\": false,\n \"replicated\":\
+ \ false,\n \"rollover_on_write\": false\n }\n ]\n}"

specification/indices/open/indicesOpenResponseExample1.yaml

@@ -0,0 +1,5 @@
+summary: A successful response for opening an index.
+description: ''
+type: response
+response_code: 200
+value: "{\n \"acknowledged\" : true,\n \"shards_acknowledged\" : true\n}"

specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample1.yaml

@@ -0,0 +1,5 @@
+summary: Configures a data stream lifecycle.
+method_request: PUT _data_stream/my-data-stream/_lifecycle
+description: Sets the lifecycle of a data stream.
+type: request
+value: "{\n \"data_retention\": \"7d\"\n}"

specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample2.yaml

@@ -0,0 +1,7 @@
+summary: Configures a data stream lifecycle.
+method_request: PUT _data_stream/my-weather-sensor-data-stream/_lifecycle
+description: This example configures two downsampling rounds.
+type: request
+value: "{\n \"downsampling\": [\n {\n \"after\": \"1d\",\n \"\
+ fixed_interval\": \"10m\"\n },\n {\n \"after\": \"7d\",\n \
+ \ \"fixed_interval\": \"1d\"\n }\n ]\n}"

specification/indices/put_data_lifecycle/IndicesPutDataLifecycleResponseExample1.yaml

@@ -0,0 +1,5 @@
+summary: A successful response for configuring a data stream lifecycle.
+description: ''
+type: response
+response_code: 200
+value: "{\n \"acknowledged\": true\n}"