Browse Source

[DOCS] Fix query params for create snapshot API (#76436)

Moves the `master_timeout` and `wait_for_completion` parameters to a query parameters section.
James Rodewig 4 years ago
parent
commit
20f000e95a
1 changed files with 10 additions and 8 deletions
  1. 10 8
      docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc

+ 10 - 8
docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc

@@ -79,6 +79,16 @@ Name of the repository to create a snapshot in.
 (Required, string)
 Name of the snapshot to create. This name must be unique in the snapshot repository.
 
+[[create-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 snapshot
+is complete. If `false`, the request returns a response when the snapshot
+initializes. Defaults to `false`.
+
 [role="child_attributes"]
 [[create-snapshot-api-request-body]]
 ==== {api-request-body-title}
@@ -130,8 +140,6 @@ By default, all available feature states will be included in the snapshot if
 `include_global_state` is `true`, or no feature states if `include_global_state`
 is `false`.
 
-include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
-
 `metadata`::
 (Optional, string)
 Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes.
@@ -143,12 +151,6 @@ If `false`, the entire snapshot will fail if one or more indices included in the
 +
 If `true`, allows taking a partial snapshot of indices with unavailable shards.
 
-`wait_for_completion`::
-(Optional, Boolean)
-If `true`, the request returns a response when the snapshot is complete.
-If `false`, the request returns a response when the snapshot initializes.
-Defaults to `false`.
-
 [[create-snapshot-api-example]]
 ==== {api-examples-title}