Skip to content

Commit eb465f5

Browse files
committed
Add overlay for create and delete document examples
1 parent 1e8ba04 commit eb465f5

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1679,6 +1679,24 @@ actions:
16791679
$ref: "../../specification/_global/bulk/examples/response/BulkResponseExample2.yaml"
16801680
bulkDocumentResponseExample3:
16811681
$ref: "../../specification/_global/bulk/examples/response/BulkResponseExample3.yaml"
1682+
- target: "$.components['requestBodies']['create']"
1683+
description: "Add example for create documents"
1684+
update:
1685+
content:
1686+
application/json:
1687+
examples:
1688+
createDocumentRequestExample1:
1689+
$ref: "../../specification/_global/create/examples/request/CreateRequestExample1.yaml"
1690+
- target: "$.paths['/{index}/_doc/{id}']['delete']"
1691+
description: "Add examples for delete document operation"
1692+
update:
1693+
responses:
1694+
200:
1695+
content:
1696+
application/json:
1697+
examples:
1698+
deleteDocumentResponseExample1:
1699+
$ref: "../../specification/_global/delete/examples/response/DeleteResponseExample1.yaml"
16821700
## Examples for licensing
16831701
- target: "$.paths['/_license']['get']"
16841702
description: "Add example for get license response"
@@ -1701,14 +1719,36 @@ actions:
17011719
$ref: "../../specification/_global/clear_scroll/examples/request/ClearScrollRequestExample1.yaml"
17021720
- target: "$.paths['/_pit']['delete']"
17031721
description: "Add examples for close PIT operation"
1704-
update:
1722+
update:
1723+
requestBody:
1724+
content:
1725+
application/json:
1726+
examples:
1727+
closePointInTimeRequestExample1:
1728+
$ref: "../../specification/_global/close_point_in_time/examples/request/ClosePointInTimeRequestExample1.yaml"
17051729
responses:
17061730
200:
17071731
content:
17081732
application/json:
17091733
examples:
17101734
closePointInTimeResponseExample1:
17111735
$ref: "../../specification/_global/close_point_in_time/examples/200_response/ClosePointInTimeResponseExample1.yaml"
1736+
- target: "$.components['requestBodies']['count']"
1737+
description: "Add example for count request"
1738+
update:
1739+
content:
1740+
application/json:
1741+
examples:
1742+
countRequestExample1:
1743+
$ref: "../../specification/_global/count/examples/request/CountRequestExample1.yaml"
1744+
- target: "$.components['responses']['count#200']"
1745+
description: "Add example for count response"
1746+
update:
1747+
content:
1748+
application/json:
1749+
examples:
1750+
countResponseExample1:
1751+
$ref: "../../specification/_global/count/examples/200_response/CountResponseExample1.yaml"
17121752
## Examples for search applications
17131753
- target: "$.paths['/_application/search_application']['get']"
17141754
description: "Add examples for get search applications operation"

0 commit comments

Comments
 (0)