Skip to content

Commit 4a30d3a

Browse files
authored
[DOCS] Convert final examples from JSON to YAML (#3692)
1 parent 2e41fc8 commit 4a30d3a

File tree

35 files changed

+326
-121
lines changed

35 files changed

+326
-121
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,28 @@ actions:
267267
examples:
268268
ccrFollowerStatsResponseExample1:
269269
$ref: "../../specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml"
270+
- target: "$.paths['/{index}/_ccr/info']['get']"
271+
description: "Add examples for get follower info"
272+
update:
273+
responses:
274+
200:
275+
content:
276+
application/json:
277+
examples:
278+
ccrFollowerInfoResponseExample1:
279+
$ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml"
280+
ccrFollowerInfoResponseExample2:
281+
$ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml"
282+
- target: "$.paths['/_ccr/auto_follow/{name}']['delete']"
283+
description: "Add examples for delete auto follow pattern"
284+
update:
285+
responses:
286+
200:
287+
content:
288+
application/json:
289+
examples:
290+
ccrAutoFollowPatternDeleteResponseExample1:
291+
$ref: "../../specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml"
270292
## Examples for cluster
271293
- target: "$.components['requestBodies']['cluster.allocation_explain']"
272294
description: "Add examples for cluster allocation explain operation"

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2463,6 +2463,30 @@ actions:
24632463
examples:
24642464
asyncSearchSubmitResponseExample1:
24652465
$ref: "../../specification/async_search/submit/examples/response/AsyncSearchSubmitResponseExample1.yaml"
2466+
- target: "$.paths['/_async_search/status/{id}']['get']"
2467+
description: "Add examples for get async search status"
2468+
update:
2469+
responses:
2470+
200:
2471+
content:
2472+
application/json:
2473+
examples:
2474+
asyncSearchStatusResponseExample1:
2475+
$ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml"
2476+
asyncSearchStatusResponseExample2:
2477+
$ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml"
2478+
asyncSearchStatusResponseExample3:
2479+
$ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml"
2480+
- target: "$.paths['/_async_search/{id}']['get']"
2481+
description: "Add examples for get async search"
2482+
update:
2483+
responses:
2484+
200:
2485+
content:
2486+
application/json:
2487+
examples:
2488+
asyncSearchResponseExample1:
2489+
$ref: "../../specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml"
24662490
## Examples for search applications
24672491
- target: "$.paths['/_application/search_application']['get']"
24682492
description: "Add examples for get search applications operation"

output/openapi/elasticsearch-openapi.json

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)