Skip to content

Commit a1a323b

Browse files
Fix Snapshot Docs Listing Query Params in Body Incorrectly (#74196) (#74205)
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 aa41089 commit a1a323b

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
@@ -73,8 +73,10 @@ NOTE: Using `_all` in a request fails if any snapshots are unavailable.
7373
Set <<get-snapshot-api-ignore-unavailable,`ignore_unavailable`>> to `true` to return only available snapshots.
7474

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

7981
[[get-snapshot-api-ignore-unavailable]]
8082
`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)