Skip to content

Commit ba84d99

Browse files
authored
[DOCS] Document missing query parms for cat recovery API (#47181) (#47237)
Documents the following query parameters for the /_cat/recovery API: * `active_only` * `detailed` * `index`
1 parent 37752a9 commit ba84d99

File tree

3 files changed

+46
-1
lines changed

3 files changed

+46
-1
lines changed

docs/reference/cat/recovery.asciidoc

+8
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ to the <<indices-recovery, indices recovery>> API.
1313

1414
`GET /_cat/recovery/<index>`
1515

16+
`GET /_cat/recovery`
17+
1618

1719
[[cat-recovery-api-desc]]
1820
==== {api-description-title}
@@ -37,14 +39,20 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
3739
[[cat-recovery-query-params]]
3840
==== {api-query-parms-title}
3941

42+
include::{docdir}/rest-api/common-parms.asciidoc[tag=active-only]
43+
4044
include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes]
4145

46+
include::{docdir}/rest-api/common-parms.asciidoc[tag=detailed]
47+
4248
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
4349

4450
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
4551

4652
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
4753

54+
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-query-parm]
55+
4856
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
4957

5058
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

docs/reference/rest-api/common-parms.asciidoc

+23
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11

2+
tag::active-only[]
3+
`active_only`::
4+
(Optional, boolean)
5+
If `true`,
6+
the response only includes ongoing shard recoveries.
7+
Defaults to `false`.
8+
end::active-only[]
9+
210
tag::index-alias[]
311
Comma-separated list or wildcard expression of index alias names
412
used to limit the request.
@@ -68,6 +76,14 @@ tag::default_operator[]
6876
Defaults to `OR`.
6977
end::default_operator[]
7078

79+
tag::detailed[]
80+
`detailed`::
81+
(Optional, boolean)
82+
If `true`,
83+
the response includes detailed information about shard recoveries.
84+
Defaults to `false`.
85+
end::detailed[]
86+
7187
tag::df[]
7288
`df`::
7389
(Optional, string) Field to use as default where no field prefix is
@@ -236,6 +252,13 @@ tag::include-unloaded-segments[]
236252
that are **not** loaded into memory. Defaults to `false`.
237253
end::include-unloaded-segments[]
238254

255+
tag::index-query-parm[]
256+
`index`::
257+
(Optional, string)
258+
Comma-separated list or wildcard expression of index names
259+
used to limit the request.
260+
end::index-query-parm[]
261+
239262
tag::index[]
240263
`<index>`::
241264
(Optional, string) Comma-separated list or wildcard expression of index names

rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json

+15-1
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,29 @@
88
"parts": {
99
"index": {
1010
"type" : "list",
11-
"description": "A comma-separated list of index names to limit the returned information"
11+
"description": "Comma-separated list or wildcard expression of index names to limit the returned information"
1212
}
1313
},
1414
"params": {
1515
"format": {
1616
"type" : "string",
1717
"description" : "a short version of the Accept header, e.g. json, yaml"
1818
},
19+
"active_only":{
20+
"type":"boolean",
21+
"description":"If `true`, the response only includes ongoing shard recoveries",
22+
"default":false
23+
},
1924
"bytes": {
2025
"type": "enum",
2126
"description" : "The unit in which to display byte values",
2227
"options": [ "b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb" ]
2328
},
29+
"detailed":{
30+
"type":"boolean",
31+
"description":"If `true`, the response includes detailed information about shard recoveries",
32+
"default":false
33+
},
2434
"master_timeout": {
2535
"type" : "time",
2636
"description" : "Explicit operation timeout for connection to master node"
@@ -34,6 +44,10 @@
3444
"description": "Return help information",
3545
"default": false
3646
},
47+
"index":{
48+
"type":"list",
49+
"description":"Comma-separated list or wildcard expression of index names to limit the returned information"
50+
},
3751
"s": {
3852
"type": "list",
3953
"description" : "Comma-separated list of column names or column aliases to sort by"

0 commit comments

Comments
 (0)