Skip to content

Commit 6c894cf

Browse files
authored
Add info and usage API examples (#3488)
1 parent a058534 commit 6c894cf

File tree

6 files changed

+622
-14
lines changed

6 files changed

+622
-14
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 10 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/xpack/info/XPackInfoRequest.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,19 @@ import { RequestBase } from '@_types/Base'
3030
* @availability stack stability=stable
3131
* @availability serverless stability=stable visibility=private
3232
* @cluster_privileges monitor
33+
* @doc_id info-api
3334
*/
3435
export interface Request extends RequestBase {
3536
query_parameters: {
3637
/**
37-
* A comma-separated list of the information categories to include in the response. For example, `build,license,features`.
38+
* A comma-separated list of the information categories to include in the response.
39+
* For example, `build,license,features`.
3840
*/
3941
categories?: XPackCategory[]
4042
accept_enterprise?: boolean
4143
/**
42-
* Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line.
44+
* Defines whether additional human-readable information is included in the response.
45+
* In particular, it adds descriptions and a tag line.
4346
* @server_default true
4447
*/
4548
human?: boolean
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# summary:
2+
description: A successful response from `GET /_xpack`.
3+
# type: response
4+
# response_code: 200
5+
value: |-
6+
{
7+
"build" : {
8+
"hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",
9+
"date" : "2015-04-07T13:34:42Z"
10+
},
11+
"license" : {
12+
"uid" : "893361dc-9749-4997-93cb-xxx",
13+
"type" : "trial",
14+
"mode" : "trial",
15+
"status" : "active",
16+
"expiry_date_in_millis" : 1542665112332
17+
},
18+
"features" : {
19+
"ccr" : {
20+
"available" : true,
21+
"enabled" : true
22+
},
23+
"aggregate_metric" : {
24+
"available" : true,
25+
"enabled" : true
26+
},
27+
"analytics" : {
28+
"available" : true,
29+
"enabled" : true
30+
},
31+
"archive" : {
32+
"available" : true,
33+
"enabled" : true
34+
},
35+
"enrich" : {
36+
"available" : true,
37+
"enabled" : true
38+
},
39+
"frozen_indices" : {
40+
"available" : true,
41+
"enabled" : true
42+
},
43+
"graph" : {
44+
"available" : true,
45+
"enabled" : true
46+
},
47+
"ilm" : {
48+
"available" : true,
49+
"enabled" : true
50+
},
51+
"logstash" : {
52+
"available" : true,
53+
"enabled" : true
54+
},
55+
"ml" : {
56+
"available" : true,
57+
"enabled" : true
58+
},
59+
"esql" : {
60+
"available" : true,
61+
"enabled" : true
62+
},
63+
"monitoring" : {
64+
"available" : true,
65+
"enabled" : true
66+
},
67+
"rollup": {
68+
"available": true,
69+
"enabled": true
70+
},
71+
"searchable_snapshots" : {
72+
"available" : true,
73+
"enabled" : true
74+
},
75+
"security" : {
76+
"available" : true,
77+
"enabled" : true
78+
},
79+
"slm" : {
80+
"available" : true,
81+
"enabled" : true
82+
},
83+
"spatial" : {
84+
"available" : true,
85+
"enabled" : true
86+
},
87+
"eql" : {
88+
"available" : true,
89+
"enabled" : true
90+
},
91+
"sql" : {
92+
"available" : true,
93+
"enabled" : true
94+
},
95+
"transform" : {
96+
"available" : true,
97+
"enabled" : true
98+
},
99+
"voting_only" : {
100+
"available" : true,
101+
"enabled" : true
102+
},
103+
"watcher" : {
104+
"available" : true,
105+
"enabled" : true
106+
},
107+
"data_streams" : {
108+
"available" : true,
109+
"enabled" : true
110+
},
111+
"data_tiers" : {
112+
"available" : true,
113+
"enabled" : true
114+
},
115+
"enterprise_search": {
116+
"available": true,
117+
"enabled": true
118+
},
119+
"universal_profiling": {
120+
"available": true,
121+
"enabled": true
122+
},
123+
"logsdb": {
124+
"available": true,
125+
"enabled": false
126+
}
127+
},
128+
"tagline" : "You know, for X"
129+
}

specification/xpack/usage/XPackUsageRequest.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,14 @@ import { Duration } from '@_types/Time'
2828
* @availability stack stability=stable
2929
* @availability serverless stability=stable visibility=private
3030
* @cluster_privileges monitor
31+
* @doc_id usage-api
3132
*/
3233
export interface Request extends RequestBase {
3334
query_parameters: {
3435
/**
35-
* Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
36+
* The period to wait for a connection to the master node.
37+
* If no response is received before the timeout expires, the request fails and returns an error.
38+
* To indicate that the request should never timeout, set it to `-1`.
3639
* @server_default 30s
3740
*/
3841
master_timeout?: Duration

0 commit comments

Comments
 (0)