From b98c57ab2197023ee29f23330da6e13bd9a0a5b0 Mon Sep 17 00:00:00 2001
From: James Rodewig <james.rodewig@elastic.co>
Date: Fri, 27 Sep 2019 16:31:10 -0400
Subject: [PATCH] [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`
---
 docs/reference/cat/recovery.asciidoc          |  8 +++++++
 docs/reference/rest-api/common-parms.asciidoc | 23 +++++++++++++++++++
 .../rest-api-spec/api/cat.recovery.json       | 16 ++++++++++++-
 3 files changed, 46 insertions(+), 1 deletion(-)

diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc
index d77a7301b1c..aadf1355234 100644
--- a/docs/reference/cat/recovery.asciidoc
+++ b/docs/reference/cat/recovery.asciidoc
@@ -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}
@@ -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]
diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc
index d797eb7800a..41a0c3d5e0a 100644
--- a/docs/reference/rest-api/common-parms.asciidoc
+++ b/docs/reference/rest-api/common-parms.asciidoc
@@ -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.
@@ -75,6 +83,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 
@@ -243,6 +259,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
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json
index 3cd49044382..7459e9e3b82 100644
--- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json
+++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json
@@ -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"
             }
           }
         }
@@ -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",
@@ -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"
@@ -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"