瀏覽代碼

[DOCS] Create common parameters file for REST APIs (#45117)

James Rodewig 6 年之前
父節點
當前提交
a9700eee37

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
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
 

+ 1 - 1
docs/reference/ilm/apis/start.asciidoc

@@ -22,7 +22,7 @@ necessary if it has been stopped using the <<ilm-stop, Stop {ilm-init} API>>.
 
 ==== Request Parameters
 
-include::{docdir}/rest-api/timeoutparms.asciidoc[]
+include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
 
 ==== Authorization
 

+ 1 - 1
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
 

+ 12 - 0
docs/reference/rest-api/common-parms.asciidoc

@@ -0,0 +1,12 @@
+
+tag::timeoutparms[]
+`timeout`::
+(Optional, <<time-units, 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`.
+
+`master_timeout`::
+(Optional, <<time-units, 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`.
+end::timeoutparms[]

+ 0 - 11
docs/reference/rest-api/timeoutparms.asciidoc

@@ -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 <<time-units>>.
-
-`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 <<time-units>>.