Skip to content

Commit 8d1dc45

Browse files
committed
Add examples to cluster APIs via overlay
1 parent 86eb11a commit 8d1dc45

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,38 @@ actions:
1919
x-feedbackLink:
2020
label: Feedback
2121
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
22+
- target: "$.components['requestBodies']['cluster.allocation_explain']"
23+
description: "Add examples for cluster allocation explain operation"
24+
update:
25+
content:
26+
application/json:
27+
examples:
28+
clusterAllocationExplainRequestExample1:
29+
$ref: "../../specification/cluster/allocation_explain/clusterAllocationExplainRequestExample1.json"
30+
- target: "$.components['responses']['cluster.health#200']"
31+
description: "Add examples for cluster health operation"
32+
update:
33+
content:
34+
application/json:
35+
examples:
36+
clusterHealthResponseExample1:
37+
$ref: "../../specification/cluster/health/clusterHealthResponseExample1.json"
38+
- target: "$.paths['/_cluster/settings']['put']"
39+
description: "Add examples for cluster update settings operation"
40+
update:
41+
requestBody:
42+
content:
43+
application/json:
44+
examples:
45+
clusterPutSettingsRequestExample1:
46+
$ref: "../../specification/cluster/put_settings/clusterPutSettingsRequestExample1.json"
47+
- target: "$.paths['/_cluster/reroute']['post']"
48+
description: "Add examples for cluster reroute operation"
49+
update:
50+
requestBody:
51+
content:
52+
application/json:
53+
examples:
54+
clusterRerouteRequestExample1:
55+
$ref: "../../specification/cluster/reroute/clusterRerouteRequestExample1.json"
56+

0 commit comments

Comments
 (0)