From 5f3ef2e09ca31561b6beb6773d8d3cf3dbf96054 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 14 Oct 2019 11:38:46 -0400 Subject: [PATCH] [DOCS] Remove unsupported `local` and `master_timeout` parms from cat API docs (#47933) --- docs/reference/cat/alias.asciidoc | 2 -- docs/reference/cat/count.asciidoc | 4 ---- docs/reference/cat/fielddata.asciidoc | 4 ---- docs/reference/cat/health.asciidoc | 4 ---- docs/reference/cat/recovery.asciidoc | 4 ---- docs/reference/cat/snapshots.asciidoc | 2 -- docs/reference/cat/tasks.asciidoc | 2 -- .../src/main/resources/rest-api-spec/api/cat.aliases.json | 4 ---- .../src/main/resources/rest-api-spec/api/cat.count.json | 8 -------- .../main/resources/rest-api-spec/api/cat.fielddata.json | 8 -------- .../src/main/resources/rest-api-spec/api/cat.health.json | 8 -------- .../main/resources/rest-api-spec/api/cat.recovery.json | 4 ---- 12 files changed, 54 deletions(-) diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index f795b38e686..7259c8d7d0d 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -34,8 +34,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=help] 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=cat-s] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/count.asciidoc b/docs/reference/cat/count.asciidoc index 3b126545064..7ae127885f5 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -34,10 +34,6 @@ 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=local] - -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] - include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/fielddata.asciidoc b/docs/reference/cat/fielddata.asciidoc index 3882848f703..27a21cc9fba 100644 --- a/docs/reference/cat/fielddata.asciidoc +++ b/docs/reference/cat/fielddata.asciidoc @@ -31,10 +31,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] -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=cat-h] include::{docdir}/rest-api/common-parms.asciidoc[tag=help] diff --git a/docs/reference/cat/health.asciidoc b/docs/reference/cat/health.asciidoc index 667df47963a..f9a9003ac22 100644 --- a/docs/reference/cat/health.asciidoc +++ b/docs/reference/cat/health.asciidoc @@ -45,10 +45,6 @@ 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=local] - -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] - include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] include::{docdir}/rest-api/common-parms.asciidoc[tag=time] diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index fedb77a1099..4848adbe09d 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -50,10 +50,6 @@ 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] - include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] include::{docdir}/rest-api/common-parms.asciidoc[tag=time] diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index b5bf30edb3f..59a23fae00f 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -95,8 +95,6 @@ Reason for any snapshot failures. include::{docdir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] - `ignore_unavailable`:: (Optional, boolean) If `true`, the response does not include information from unavailable snapshots. Defaults to `false`. diff --git a/docs/reference/cat/tasks.asciidoc b/docs/reference/cat/tasks.asciidoc index af208ef20cb..cc30486859c 100644 --- a/docs/reference/cat/tasks.asciidoc +++ b/docs/reference/cat/tasks.asciidoc @@ -51,8 +51,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=help] include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id-query-parm] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] - include::{docdir}/rest-api/common-parms.asciidoc[tag=parent-task-id] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json index 0f49d3a8b74..d37273cfd41 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json @@ -36,10 +36,6 @@ "type":"boolean", "description":"Return local information, do not retrieve the state from master node (default: false)" }, - "master_timeout":{ - "type":"time", - "description":"Explicit operation timeout for connection to master node" - }, "h":{ "type":"list", "description":"Comma-separated list of column names to display" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json index 807e108e788..8cfaddf8db8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json @@ -32,14 +32,6 @@ "type":"string", "description":"a short version of the Accept header, e.g. json, yaml" }, - "local":{ - "type":"boolean", - "description":"Return local information, do not retrieve the state from master node (default: false)" - }, - "master_timeout":{ - "type":"time", - "description":"Explicit operation timeout for connection to master node" - }, "h":{ "type":"list", "description":"Comma-separated list of column names to display" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json index a3d05537f81..9fbde4736b5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json @@ -49,14 +49,6 @@ "pb" ] }, - "local":{ - "type":"boolean", - "description":"Return local information, do not retrieve the state from master node (default: false)" - }, - "master_timeout":{ - "type":"time", - "description":"Explicit operation timeout for connection to master node" - }, "h":{ "type":"list", "description":"Comma-separated list of column names to display" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json index 50e2cf8c72a..7e79b7cc2c9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json @@ -20,14 +20,6 @@ "type":"string", "description":"a short version of the Accept header, e.g. json, yaml" }, - "local":{ - "type":"boolean", - "description":"Return local information, do not retrieve the state from master node (default: false)" - }, - "master_timeout":{ - "type":"time", - "description":"Explicit operation timeout for connection to master node" - }, "h":{ "type":"list", "description":"Comma-separated list of column names to display" 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 c24e8854a72..64c102d0897 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 @@ -59,10 +59,6 @@ "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" - }, "h":{ "type":"list", "description":"Comma-separated list of column names to display"