Skip to content

Commit c63f282

Browse files
committed
Add overlay for more global examples
1 parent c016ac3 commit c63f282

File tree

2 files changed

+87
-0
lines changed

2 files changed

+87
-0
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1733,6 +1733,63 @@ actions:
17331733
$ref: "../../specification/_global/get/examples/response/GetResponseExample2.yaml"
17341734
getDocumentResponseExample3:
17351735
$ref: "../../specification/_global/get/examples/response/GetResponseExample3.yaml"
1736+
- target: "$.components['requestBodies']['index']"
1737+
description: "Add example for index request"
1738+
update:
1739+
content:
1740+
application/json:
1741+
examples:
1742+
indexRequestExample1:
1743+
$ref: "../../specification/_global/index/examples/request/IndexRequestExample1.yaml"
1744+
indexRequestExample2:
1745+
$ref: "../../specification/_global/index/examples/request/IndexRequestExample2.yaml"
1746+
- target: "$.components['responses']['index#200']"
1747+
description: "Add example for index response"
1748+
update:
1749+
content:
1750+
application/json:
1751+
examples:
1752+
indexResponseExample1:
1753+
$ref: "../../specification/_global/index/examples/response/IndexResponseExample1.yaml"
1754+
indexResponseExample2:
1755+
$ref: "../../specification/_global/index/examples/response/IndexResponseExample2.yaml"
1756+
- target: "$.components['requestBodies']['mget']"
1757+
description: "Add example for mget request"
1758+
update:
1759+
content:
1760+
application/json:
1761+
examples:
1762+
mgetRequestExample1:
1763+
$ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample1.yaml"
1764+
mgetRequestExample2:
1765+
$ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample2.yaml"
1766+
mgetRequestExample3:
1767+
$ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample3.yaml"
1768+
mgetRequestExample4:
1769+
$ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample4.yaml"
1770+
- target: "$.components['requestBodies']['mtermvectors']"
1771+
description: "Add example for multi term vectors request"
1772+
update:
1773+
content:
1774+
application/json:
1775+
examples:
1776+
multiTermVectorsRequestExample1:
1777+
$ref: "../../specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample1.yaml"
1778+
multiTermVectorsRequestExample2:
1779+
$ref: "../../specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample2.yaml"
1780+
multiTermVectorsRequestExample3:
1781+
$ref: "../../specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample3.yaml"
1782+
## Examples for info
1783+
- target: "$.paths['/']['get']"
1784+
description: "Add examples for cluster info"
1785+
update:
1786+
responses:
1787+
200:
1788+
content:
1789+
application/json:
1790+
examples:
1791+
catMasterResponseExample1:
1792+
$ref: "../../specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml"
17361793
## Examples for licensing
17371794
- target: "$.paths['/_license']['get']"
17381795
description: "Add example for get license response"
@@ -1744,6 +1801,17 @@ actions:
17441801
examples:
17451802
getLicenseResponseExample1:
17461803
$ref: "../../specification/license/get/examples/response/GetLicenseResponseExample1.yaml"
1804+
## Examples for script
1805+
- target: "$.components['requestBodies']['put_script']"
1806+
description: "Add example for create script request"
1807+
update:
1808+
content:
1809+
application/json:
1810+
examples:
1811+
putScriptRequestExample1:
1812+
$ref: "../../specification/_global/put_script/examples/request/PutScriptRequestExample1.yaml"
1813+
putScriptRequestExample2:
1814+
$ref: "../../specification/_global/put_script/examples/request/PutScriptRequestExample2.yaml"
17471815
## Examples for search
17481816
- target: "$.components['requestBodies']['clear_scroll']"
17491817
description: "Add example for clear scroll request"
@@ -1819,6 +1887,24 @@ actions:
18191887
$ref: "../../specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml"
18201888
fieldCapabilitiesResponseExample2:
18211889
$ref: "../../specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml"
1890+
- target: "$.components['requestBodies']['msearch_template']"
1891+
description: "Add example for multi search template request"
1892+
update:
1893+
content:
1894+
application/json:
1895+
examples:
1896+
multiSearchTemplateRequestExample1:
1897+
$ref: "../../specification/_global/msearch_template/examples/request/MultiSearchTemplateRequestExample1.yaml"
1898+
- target: "$.paths['/{index}/_pit']['post']"
1899+
description: "Add examples for open PIT operation"
1900+
update:
1901+
responses:
1902+
200:
1903+
content:
1904+
application/json:
1905+
examples:
1906+
openPointInTimeResponseExample1:
1907+
$ref: "../../specification/_global/open_point_in_time/examples/response/OpenPointInTimeResponseExample1.yaml"
18221908
## Examples for search applications
18231909
- target: "$.paths['/_application/search_application']['get']"
18241910
description: "Add examples for get search applications operation"

specification/_global/info/RootNodeInfoRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { RequestBase } from '@_types/Base'
2727
* @availability serverless stability=stable visibility=public
2828
* @cluster_privileges monitor
2929
* @doc_id api-root
30+
* @doc_tag info
3031
*/
3132
export interface Request extends RequestBase {
3233
urls: [

0 commit comments

Comments
 (0)