Skip to content

Commit 4456048

Browse files
committed
Add example overlays for open index, get data stream, get lifecycle
1 parent e71f2a3 commit 4456048

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,3 +253,14 @@ actions:
253253
examples:
254254
indicesDataStreamStatsResponseExample1:
255255
$ref: "../../specification/indices/data_streams_stats/indicesDataStreamStatsResponseExample1.yaml"
256+
- target: "$.paths['/{index}/_open']['post']"
257+
description: "Add examples for open index response"
258+
update:
259+
responses:
260+
200:
261+
content:
262+
application/json:
263+
examples:
264+
indicesOpenResponseExample1:
265+
$ref: "../../specification/indices/open/indicesOpenResponseExample1.yaml"
266+

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ actions:
117117
examples:
118118
previewTransformRequestExample1:
119119
$ref: "../../specification/transform/preview_transform/PreviewTransformRequestExample1.json"
120-
- target: "$.components['reponses']['transform.preview_transform#200']"
120+
- target: "$.components['responses']['transform.preview_transform#200']"
121121
description: "Add examples for preview transform operation"
122122
update:
123123
content:
@@ -224,4 +224,22 @@ actions:
224224
application/json:
225225
examples:
226226
indicesDeleteDataLifecycleResponseExample1:
227-
$ref: "../../specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleResponseExample1.yaml"
227+
$ref: "../../specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleResponseExample1.yaml"
228+
- target: "$.paths['/_data_stream/{name}/_lifecycle']['get']"
229+
description: "Add example for get data stream lifecycle response"
230+
update:
231+
responses:
232+
200:
233+
content:
234+
application/json:
235+
examples:
236+
indicesGetDataLifecycleResponseExample1:
237+
$ref: "../../specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponseExample1.yaml"
238+
- target: "$.components['responses']['indices.get_data_stream#200']"
239+
description: "Add example for get data stream response"
240+
update:
241+
content:
242+
application/json:
243+
examples:
244+
indicesGetDataStreamResponseExample:
245+
$ref: "../../specification/indices/get_data_stream/indicesGetDataStreamResponseExample1.yaml"

0 commit comments

Comments
 (0)