Skip to content

Commit 1f5f223

Browse files
committed
Add overlay for delete by query and explain examples
1 parent eb465f5 commit 1f5f223

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1697,6 +1697,28 @@ actions:
16971697
examples:
16981698
deleteDocumentResponseExample1:
16991699
$ref: "../../specification/_global/delete/examples/response/DeleteResponseExample1.yaml"
1700+
- target: "$.paths['/{index}/_delete_by_query']['post']"
1701+
description: "Add examples delete by query operation"
1702+
update:
1703+
requestBody:
1704+
content:
1705+
application/json:
1706+
examples:
1707+
deleteByQueryRequestExample1:
1708+
$ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample1.yaml"
1709+
deleteByQueryRequestExample2:
1710+
$ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample2.yaml"
1711+
deleteByQueryRequestExample3:
1712+
$ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample3.yaml"
1713+
deleteByQueryRequestExample4:
1714+
$ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample4.yaml"
1715+
responses:
1716+
200:
1717+
content:
1718+
application/json:
1719+
examples:
1720+
deleteDocumentResponseExample1:
1721+
$ref: "../../specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml"
17001722
## Examples for licensing
17011723
- target: "$.paths['/_license']['get']"
17021724
description: "Add example for get license response"
@@ -1749,6 +1771,22 @@ actions:
17491771
examples:
17501772
countResponseExample1:
17511773
$ref: "../../specification/_global/count/examples/200_response/CountResponseExample1.yaml"
1774+
- target: "$.components['requestBodies']['explain']"
1775+
description: "Add example for explain request"
1776+
update:
1777+
content:
1778+
application/json:
1779+
examples:
1780+
explainRequestExample1:
1781+
$ref: "../../specification/_global/explain/examples/request/ExplainRequestExample1.yaml"
1782+
- target: "$.components['responses']['explain#200']"
1783+
description: "Add example for explain response"
1784+
update:
1785+
content:
1786+
application/json:
1787+
examples:
1788+
explainResponseExample1:
1789+
$ref: "../../specification/_global/explain/examples/response/ExplainResponseExample1.yaml"
17521790
## Examples for search applications
17531791
- target: "$.paths['/_application/search_application']['get']"
17541792
description: "Add examples for get search applications operation"

0 commit comments

Comments
 (0)