[DOCS] Create common parameters file for REST APIs (#45117)
This commit is contained in:
parent
6b71621afc
commit
f657f3914d
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -28,7 +28,7 @@ previous versions.
|
|||
|
||||
==== Request Parameters
|
||||
|
||||
include::{docdir}/rest-api/timeoutparms.asciidoc[]
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||
|
||||
==== Authorization
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ indices.
|
|||
|
||||
==== Request Parameters
|
||||
|
||||
include::{docdir}/rest-api/timeoutparms.asciidoc[]
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||
|
||||
==== Authorization
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ step.
|
|||
|
||||
==== Request Parameters
|
||||
|
||||
include::{docdir}/rest-api/timeoutparms.asciidoc[]
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||
|
||||
==== Authorization
|
||||
|
||||
|
|
|
@ -33,7 +33,7 @@ applied.
|
|||
|
||||
==== Request Parameters
|
||||
|
||||
include::{docdir}/rest-api/timeoutparms.asciidoc[]
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||
|
||||
==== Authorization
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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[]
|
|
@ -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>>.
|
Loading…
Reference in New Issue