From 1a807ef4a25777a7840385ee4a2313b3ebd227c0 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 20 May 2021 08:38:37 -0400 Subject: [PATCH] [DOCS] Fix query parameters for restore API (#73015) --- .../apis/restore-snapshot-api.asciidoc | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc index 5a4da87aec0d9..21657ade44e53 100644 --- a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc @@ -99,6 +99,16 @@ Name of the repository to restore a snapshot from. (Required, string) Name of the snapshot to restore. +[[restore-snapshot-api-query-params]] +==== {api-query-parms-title} + +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] + +`wait_for_completion`:: +(Optional, Boolean) If `true`, the request returns a response when the restore +operation completes. If `false`, the request returns a response when the restore +operation initializes. Defaults to `false`. + [role="child_attributes"] [[restore-snapshot-api-request-body]] ==== {api-request-body-title} @@ -204,14 +214,6 @@ include::{es-ref-dir}/snapshot-restore/restore-snapshot.asciidoc[tag=rename-rest (Optional, string) Defines the rename replacement string. See <> for more information. -`wait_for_completion`:: -(Optional, Boolean) -If `false`, the request returns a response when the restore operation initializes. -Defaults to `false`. -+ -If `true`, the request returns a response when the restore operation -completes. - [[restore-snapshot-api-example]] ==== {api-examples-title}