Skip to content

Commit 683239b

Browse files
authored
Add datastream examples (#3429)
1 parent ec9e440 commit 683239b

File tree

4 files changed

+22
-3
lines changed

4 files changed

+22
-3
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary:
2+
# method_request: POST /my-time-series-index/_downsample/my-downsampled-time-series-index
3+
# description: ''
4+
# type: request
5+
value:
6+
fixed_interval: 1d

specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# summary: ''
2-
description: A successful response for retrieving data stream lifecycle status for a data stream backing index.
1+
summary: Successful response
2+
description: >
3+
A successful response from `GET .ds-metrics-2023.03.22-000001/_lifecycle/explain`, which retrieves the lifecycle status for a data stream backing index. If the index is managed by a data stream lifecycle, the API will show the `managed_by_lifecycle` field set to `true` and the rest of the response will contain information about the lifecycle execution status for this index.
34
# type: response
45
# response_code: 200
56
value:
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
summary: Successful response with error messages
2+
description: The API reports any errors related to the lifecycle execution for the target index.
3+
# type: response
4+
# response_code: ''
5+
value:
6+
"{\n \"indices\": {\n \".ds-metrics-2023.03.22-000001\": {\n \"index\"\
7+
\ : \".ds-metrics-2023.03.22-000001\",\n \"managed_by_lifecycle\" : true,\n\
8+
\ \"index_creation_date_millis\" : 1679475563571,\n \"time_since_index_creation\"\
9+
\ : \"843ms\",\n \"lifecycle\" : {\n \"enabled\": true\n },\n \
10+
\ \"error\": \"{\\\"type\\\":\\\"validation_exception\\\",\\\"reason\\\":\\\"\
11+
Validation Failed: 1: this action would add [2] shards, but this cluster\ncurrently\
12+
\ has [4]/[3] maximum normal shards open;\\\"}\"\n }\n}"

specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponseExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# summary:
2-
description: A successful response of getting the lifecycle of a set of data streams.
2+
description: A successful response from `GET _lifecycle/stats?human&pretty`.
33
# type: response
44
# response_code: 200
55
value:

0 commit comments

Comments
 (0)