[DOCS] Document missing query parms for cat recovery API (#47181) (#47235)

Documents the following query parameters for
the /_cat/recovery API:

* `active_only`
* `detailed`
* `index`
This commit is contained in:
James Rodewig 2019-09-27 16:31:10 -04:00 committed by GitHub
parent e11c56760d
commit b98c57ab21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 46 additions and 1 deletions

View File

@ -13,6 +13,8 @@ to the <<indices-recovery, indices recovery>> API.
`GET /_cat/recovery/<index>` `GET /_cat/recovery/<index>`
`GET /_cat/recovery`
[[cat-recovery-api-desc]] [[cat-recovery-api-desc]]
==== {api-description-title} ==== {api-description-title}
@ -37,14 +39,20 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
[[cat-recovery-query-params]] [[cat-recovery-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=active-only]
include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{docdir}/rest-api/common-parms.asciidoc[tag=detailed]
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{docdir}/rest-api/common-parms.asciidoc[tag=help] include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-query-parm]
include::{docdir}/rest-api/common-parms.asciidoc[tag=local] include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

View File

@ -1,4 +1,12 @@
tag::active-only[]
`active_only`::
(Optional, boolean)
If `true`,
the response only includes ongoing shard recoveries.
Defaults to `false`.
end::active-only[]
tag::index-alias[] tag::index-alias[]
Comma-separated list or wildcard expression of index alias names Comma-separated list or wildcard expression of index alias names
used to limit the request. used to limit the request.
@ -75,6 +83,14 @@ tag::default_operator[]
Defaults to `OR`. Defaults to `OR`.
end::default_operator[] end::default_operator[]
tag::detailed[]
`detailed`::
(Optional, boolean)
If `true`,
the response includes detailed information about shard recoveries.
Defaults to `false`.
end::detailed[]
tag::df[] tag::df[]
`df`:: `df`::
(Optional, string) Field to use as default where no field prefix is (Optional, string) Field to use as default where no field prefix is
@ -243,6 +259,13 @@ tag::include-unloaded-segments[]
that are **not** loaded into memory. Defaults to `false`. that are **not** loaded into memory. Defaults to `false`.
end::include-unloaded-segments[] end::include-unloaded-segments[]
tag::index-query-parm[]
`index`::
(Optional, string)
Comma-separated list or wildcard expression of index names
used to limit the request.
end::index-query-parm[]
tag::index[] tag::index[]
`<index>`:: `<index>`::
(Optional, string) Comma-separated list or wildcard expression of index names (Optional, string) Comma-separated list or wildcard expression of index names

View File

@ -21,7 +21,7 @@
"parts":{ "parts":{
"index":{ "index":{
"type":"list", "type":"list",
"description":"A comma-separated list of index names to limit the returned information" "description":"Comma-separated list or wildcard expression of index names to limit the returned information"
} }
} }
} }
@ -32,6 +32,11 @@
"type":"string", "type":"string",
"description":"a short version of the Accept header, e.g. json, yaml" "description":"a short version of the Accept header, e.g. json, yaml"
}, },
"active_only":{
"type":"boolean",
"description":"If `true`, the response only includes ongoing shard recoveries",
"default":false
},
"bytes":{ "bytes":{
"type":"enum", "type":"enum",
"description":"The unit in which to display byte values", "description":"The unit in which to display byte values",
@ -49,6 +54,11 @@
"pb" "pb"
] ]
}, },
"detailed":{
"type":"boolean",
"description":"If `true`, the response includes detailed information about shard recoveries",
"default":false
},
"master_timeout":{ "master_timeout":{
"type":"time", "type":"time",
"description":"Explicit operation timeout for connection to master node" "description":"Explicit operation timeout for connection to master node"
@ -62,6 +72,10 @@
"description":"Return help information", "description":"Return help information",
"default":false "default":false
}, },
"index":{
"type":"list",
"description":"Comma-separated list or wildcard expression of index names to limit the returned information"
},
"s":{ "s":{
"type":"list", "type":"list",
"description":"Comma-separated list of column names or column aliases to sort by" "description":"Comma-separated list of column names or column aliases to sort by"