From a05cc8061baabb01b45f295252f32126d7cf6606 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 12 May 2021 16:08:13 -0400 Subject: [PATCH 1/2] [DOCS] Fix query parameters for restore API Changes: * Documents the `master_timeout` query param * Moves `wait_for_completion` to the query param section --- .../apis/restore-snapshot-api.asciidoc | 19 +++++++++++-------- 1 file changed, 11 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 9982968884cb5..2b3a8e775b863 100644 --- a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc @@ -99,6 +99,17 @@ 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} @@ -199,14 +210,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} From 870c30c1d276dd9dd61856e476a14c4f9eff08cf Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 18 May 2021 14:43:56 -0400 Subject: [PATCH 2/2] Rewrap --- .../snapshot-restore/apis/restore-snapshot-api.asciidoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc index 2b3a8e775b863..f0338fa9cacac 100644 --- a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc @@ -105,10 +105,9 @@ Name of the snapshot to restore. 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`. +(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]]