Skip to content

Commit b94cf37

Browse files
committed
Add overlay for get document and field caps examples
1 parent 1f5f223 commit b94cf37

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1719,6 +1719,20 @@ actions:
17191719
examples:
17201720
deleteDocumentResponseExample1:
17211721
$ref: "../../specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml"
1722+
- target: "$.paths['/{index}/_doc/{id}']['get']"
1723+
description: "Add examples for get document operation"
1724+
update:
1725+
responses:
1726+
200:
1727+
content:
1728+
application/json:
1729+
examples:
1730+
getDocumentResponseExample1:
1731+
$ref: "../../specification/_global/get/examples/response/GetResponseExample1.yaml"
1732+
getDocumentResponseExample2:
1733+
$ref: "../../specification/_global/get/examples/response/GetResponseExample2.yaml"
1734+
getDocumentResponseExample3:
1735+
$ref: "../../specification/_global/get/examples/response/GetResponseExample3.yaml"
17221736
## Examples for licensing
17231737
- target: "$.paths['/_license']['get']"
17241738
description: "Add example for get license response"
@@ -1787,6 +1801,24 @@ actions:
17871801
examples:
17881802
explainResponseExample1:
17891803
$ref: "../../specification/_global/explain/examples/response/ExplainResponseExample1.yaml"
1804+
- target: "$.components['requestBodies']['field_caps']"
1805+
description: "Add example for field capabilities request"
1806+
update:
1807+
content:
1808+
application/json:
1809+
examples:
1810+
fieldCapabilitiesRequestExample1:
1811+
$ref: "../../specification/_global/field_caps/examples/request/FieldCapabilitiesRequestExample1.yaml"
1812+
- target: "$.components['responses']['field_caps#200']"
1813+
description: "Add example for field capabilities response"
1814+
update:
1815+
content:
1816+
application/json:
1817+
examples:
1818+
fieldCapabilitiesResponseExample1:
1819+
$ref: "../../specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml"
1820+
fieldCapabilitiesResponseExample2:
1821+
$ref: "../../specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml"
17901822
## Examples for search applications
17911823
- target: "$.paths['/_application/search_application']['get']"
17921824
description: "Add examples for get search applications operation"

0 commit comments

Comments
 (0)