Skip to content

Commit e8662e3

Browse files
Fix Snapshot Docs Listing Query Params in Body Incorrectly (#74196)
Both of these APIs don't parse request bodies, the parameters are all taken from the query string. Also, included the master timeout param include as it was missing here also.
1 parent c7d59f0 commit e8662e3

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,10 @@ NOTE: Using `_all` in a request fails if any snapshots are unavailable.
7474
Set <<get-snapshot-api-ignore-unavailable,`ignore_unavailable`>> to `true` to return only available snapshots.
7575

7676
[role="child_attributes"]
77-
[[get-snapshot-api-request-body]]
78-
==== {api-request-body-title}
77+
[[get-snapshot-api-query-params]]
78+
==== {api-query-parms-title}
79+
80+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
7981

8082
[[get-snapshot-api-ignore-unavailable]]
8183
`ignore_unavailable`::

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,10 @@ To retrieve a list of all snapshots in a specified repository, omit this paramet
115115
NOTE: Wildcard (`*`) expressions are not supported for `<snapshot>`.
116116

117117
[role="child_attributes"]
118-
[[get-snapshot-status-api-request-body]]
119-
==== {api-request-body-title}
118+
[[get-snapshot-status-api-query-params]]
119+
==== {api-query-parms-title}
120+
121+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
120122

121123
`ignore_unavailable`::
122124
(Optional, Boolean)

0 commit comments

Comments
 (0)