From f657f3914d36494f1de07b411e79b600322ec621 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Fri, 2 Aug 2019 08:42:33 -0400 Subject: [PATCH] [DOCS] Create common parameters file for REST APIs (#45117) --- docs/reference/ilm/apis/delete-lifecycle.asciidoc | 2 +- docs/reference/ilm/apis/explain.asciidoc | 2 +- docs/reference/ilm/apis/get-lifecycle.asciidoc | 2 +- docs/reference/ilm/apis/get-status.asciidoc | 2 +- docs/reference/ilm/apis/move-to-step.asciidoc | 2 +- docs/reference/ilm/apis/put-lifecycle.asciidoc | 2 +- .../ilm/apis/remove-policy-from-index.asciidoc | 2 +- docs/reference/ilm/apis/retry-policy.asciidoc | 2 +- docs/reference/ilm/apis/slm-api.asciidoc | 2 +- docs/reference/ilm/apis/start.asciidoc | 2 +- docs/reference/ilm/apis/stop.asciidoc | 2 +- docs/reference/rest-api/common-parms.asciidoc | 12 ++++++++++++ docs/reference/rest-api/timeoutparms.asciidoc | 11 ----------- 13 files changed, 23 insertions(+), 22 deletions(-) create mode 100644 docs/reference/rest-api/common-parms.asciidoc delete mode 100644 docs/reference/rest-api/timeoutparms.asciidoc diff --git a/docs/reference/ilm/apis/delete-lifecycle.asciidoc b/docs/reference/ilm/apis/delete-lifecycle.asciidoc index 9c455428360..8d959049fb1 100644 --- a/docs/reference/ilm/apis/delete-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/delete-lifecycle.asciidoc @@ -25,7 +25,7 @@ the request fails and returns an error. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/explain.asciidoc b/docs/reference/ilm/apis/explain.asciidoc index 3aa2572175e..5202d384364 100644 --- a/docs/reference/ilm/apis/explain.asciidoc +++ b/docs/reference/ilm/apis/explain.asciidoc @@ -35,7 +35,7 @@ about any failures. ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/get-lifecycle.asciidoc b/docs/reference/ilm/apis/get-lifecycle.asciidoc index a36703967af..902ea39e454 100644 --- a/docs/reference/ilm/apis/get-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/get-lifecycle.asciidoc @@ -25,7 +25,7 @@ modified date. If no policy is specified, returns all defined policies. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/get-status.asciidoc b/docs/reference/ilm/apis/get-status.asciidoc index af8a4deffcb..719bafe536c 100644 --- a/docs/reference/ilm/apis/get-status.asciidoc +++ b/docs/reference/ilm/apis/get-status.asciidoc @@ -23,7 +23,7 @@ or `STOPPED`. You can change the status of the {ilm-init} plugin with the ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/move-to-step.asciidoc b/docs/reference/ilm/apis/move-to-step.asciidoc index 57ea1a226ea..f5da5370b1a 100644 --- a/docs/reference/ilm/apis/move-to-step.asciidoc +++ b/docs/reference/ilm/apis/move-to-step.asciidoc @@ -34,7 +34,7 @@ an unexpected step into the next step. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/put-lifecycle.asciidoc b/docs/reference/ilm/apis/put-lifecycle.asciidoc index 3e07e5f0f03..7e7c159c20d 100644 --- a/docs/reference/ilm/apis/put-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/put-lifecycle.asciidoc @@ -28,7 +28,7 @@ previous versions. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc index 888d3f17eec..ef4e9e01572 100644 --- a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc +++ b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc @@ -25,7 +25,7 @@ indices. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/retry-policy.asciidoc b/docs/reference/ilm/apis/retry-policy.asciidoc index c67540d2003..d3d5bcdfad9 100644 --- a/docs/reference/ilm/apis/retry-policy.asciidoc +++ b/docs/reference/ilm/apis/retry-policy.asciidoc @@ -25,7 +25,7 @@ step. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/slm-api.asciidoc b/docs/reference/ilm/apis/slm-api.asciidoc index bb175d67317..7b32a3fc509 100644 --- a/docs/reference/ilm/apis/slm-api.asciidoc +++ b/docs/reference/ilm/apis/slm-api.asciidoc @@ -33,7 +33,7 @@ applied. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/start.asciidoc b/docs/reference/ilm/apis/start.asciidoc index c13f5edcf11..7d3c923fc93 100644 --- a/docs/reference/ilm/apis/start.asciidoc +++ b/docs/reference/ilm/apis/start.asciidoc @@ -22,7 +22,7 @@ necessary if it has been stopped using the <>. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/ilm/apis/stop.asciidoc b/docs/reference/ilm/apis/stop.asciidoc index 1629990c5fd..85acc059d2d 100644 --- a/docs/reference/ilm/apis/stop.asciidoc +++ b/docs/reference/ilm/apis/stop.asciidoc @@ -27,7 +27,7 @@ if {ilm-init} is running. ==== Request Parameters -include::{docdir}/rest-api/timeoutparms.asciidoc[] +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] ==== Authorization diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc new file mode 100644 index 00000000000..7dd5426899f --- /dev/null +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -0,0 +1,12 @@ + +tag::timeoutparms[] +`timeout`:: +(Optional, <>) Specifies the period of time to wait for +a response. If no response is received before the timeout expires, the request +fails and returns an error. Defaults to `30s`. + +`master_timeout`:: +(Optional, <>) Specifies the period of time to wait for +a connection to the master node. If no response is received before the timeout +expires, the request fails and returns an error. Defaults to `30s`. +end::timeoutparms[] \ No newline at end of file diff --git a/docs/reference/rest-api/timeoutparms.asciidoc b/docs/reference/rest-api/timeoutparms.asciidoc deleted file mode 100644 index fc8f5208219..00000000000 --- a/docs/reference/rest-api/timeoutparms.asciidoc +++ /dev/null @@ -1,11 +0,0 @@ -`timeout`:: - (time units) Specifies the period of time to wait for a response. If no - response is received before the timeout expires, the request fails and - returns an error. Defaults to `30s`. For more information about - time units, see <>. - -`master_timeout`:: - (time units) Specifies the period of time to wait for a connection to the - master node. If no response is received before the timeout expires, the request - fails and returns an error. Defaults to `30s`. For more information about - time units, see <>.