Skip to content

Commit b31a8ff

Browse files
authored
[DOCS] Fix put repository API docs (#64811)
1 parent 52e6db5 commit b31a8ff

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

docs/reference/snapshot-restore/apis/put-repo-api.asciidoc

+24-9
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,11 @@ plugins:
150150
+
151151
--
152152
(Required, object)
153-
Contains settings for the repository. Valid properties for the `settings` object
154-
depend on the repository type, set using the
155-
<<put-snapshot-repo-api-request-type,`type`>> parameter.
153+
Contains settings for the repository.
156154

157-
.Valid `settings` properties for `fs` repositories
155+
The following `settings` properties are valid for all repository types:
156+
157+
.Properties of `settings`
158158
[%collapsible%open]
159159
====
160160
`chunk_size`::
@@ -168,11 +168,13 @@ file size).
168168
If `true`, metadata files, such as index mappings and settings, are compressed
169169
in snapshots. Data files are not compressed. Defaults to `true`.
170170
171-
`location`::
172-
(Required, string)
173-
Location of the shared filesystem used to store and retrieve snapshots. This
174-
location must be registered in the `path.repo` setting on all master and data
175-
nodes in the cluster.
171+
`max_number_of_snapshots`::
172+
(Optional, integer)
173+
Maximum number of snapshots the repository can contain. Defaults to `500`.
174+
+
175+
WARNING: We do not recommend increasing `max_number_of_snapshots`. Larger
176+
snapshot repositories may degrade master node performance and cause stability
177+
issues. Instead, delete older snapshots or use multiple repositories.
176178
177179
`max_restore_bytes_per_sec`::
178180
(Optional, <<byte-units,byte value>>)
@@ -206,6 +208,19 @@ the repository but not create snapshots in it.
206208
=====
207209
====
208210

211+
Other accepted `settings` properties depend on the repository type, set using the
212+
<<put-snapshot-repo-api-request-type,`type`>> parameter.
213+
214+
.Valid `settings` properties for `fs` repositories
215+
[%collapsible%open]
216+
====
217+
`location`::
218+
(Required, string)
219+
Location of the shared filesystem used to store and retrieve snapshots. This
220+
location must be registered in the `path.repo` setting on all master and data
221+
nodes in the cluster.
222+
====
223+
209224
.Valid `settings` properties for `source` repositories
210225
[%collapsible%open]
211226
====

0 commit comments

Comments
 (0)