Skip to content

Commit

Permalink
[DOCS] Fix query params for create snapshot API (#76436) (#76442)
Browse files Browse the repository at this point in the history
Moves the `master_timeout` and `wait_for_completion` parameters to a query parameters section.
  • Loading branch information
jrodewig authored Aug 12, 2021
1 parent edbde78 commit d84b48f
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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.
Expand All @@ -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}

Expand Down

0 comments on commit d84b48f

Please sign in to comment.