Skip to content

Commit ae48ae1

Browse files
authored
[DOCS] Fix query parameters for restore API (#73015) (#73271)
1 parent 903b7ff commit ae48ae1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@ Name of the repository to restore a snapshot from.
9999
(Required, string)
100100
Name of the snapshot to restore.
101101

102+
[[restore-snapshot-api-query-params]]
103+
==== {api-query-parms-title}
104+
105+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
106+
107+
`wait_for_completion`::
108+
(Optional, Boolean) If `true`, the request returns a response when the restore
109+
operation completes. If `false`, the request returns a response when the restore
110+
operation initializes. Defaults to `false`.
111+
102112
[role="child_attributes"]
103113
[[restore-snapshot-api-request-body]]
104114
==== {api-request-body-title}
@@ -204,14 +214,6 @@ include::{es-ref-dir}/snapshot-restore/restore-snapshot.asciidoc[tag=rename-rest
204214
(Optional, string)
205215
Defines the rename replacement string. See <<restore-snapshot-api-rename-pattern,`rename_pattern`>> for more information.
206216

207-
`wait_for_completion`::
208-
(Optional, Boolean)
209-
If `false`, the request returns a response when the restore operation initializes.
210-
Defaults to `false`.
211-
+
212-
If `true`, the request returns a response when the restore operation
213-
completes.
214-
215217
[[restore-snapshot-api-example]]
216218
==== {api-examples-title}
217219

0 commit comments

Comments
 (0)