Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/reference/cat/recovery.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ to the <<indices-recovery, indices recovery>> API.

`GET /_cat/recovery/<index>`

`GET /_cat/recovery`


[[cat-recovery-api-desc]]
==== {api-description-title}
Expand All @@ -37,14 +39,20 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
[[cat-recovery-query-params]]
==== {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=detailed]

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=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=master-timeout]
Expand Down
23 changes: 23 additions & 0 deletions docs/reference/rest-api/common-parms.asciidoc
Original file line number Diff line number Diff line change
@@ -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[]
Comma-separated list or wildcard expression of index alias names
used to limit the request.
Expand Down Expand Up @@ -67,6 +75,14 @@ tag::default_operator[]
Defaults to `OR`.
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[]
`df`::
(Optional, string) Field to use as default where no field prefix is
Expand Down Expand Up @@ -227,6 +243,13 @@ tag::include-unloaded-segments[]
that are **not** loaded into memory. Defaults to `false`.
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[]
`<index>`::
(Optional, string) Comma-separated list or wildcard expression of index names
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"parts":{
"index":{
"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"
}
}
}
Expand All @@ -32,6 +32,11 @@
"type":"string",
"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":{
"type":"enum",
"description":"The unit in which to display byte values",
Expand All @@ -49,6 +54,11 @@
"pb"
]
},
"detailed":{
"type":"boolean",
"description":"If `true`, the response includes detailed information about shard recoveries",
"default":false
},
"master_timeout":{
"type":"time",
"description":"Explicit operation timeout for connection to master node"
Expand All @@ -62,6 +72,10 @@
"description":"Return help information",
"default":false
},
"index":{
"type":"list",
"description":"Comma-separated list or wildcard expression of index names to limit the returned information"
},
"s":{
"type":"list",
"description":"Comma-separated list of column names or column aliases to sort by"
Expand Down