Skip to content

Commit 645178f

Browse files
committed
Clarify integer settings for repository-s3 repos
Today there are a handful of integer settings for `repository-s3` repositories whose docs link to the page about numeric field types. Yet these settings are not fields, and do not support floating-point values either. The convention throughout the rest of the docs is to just call these things `integer` without linking to anything. This commit aligns the `repository-s3` docs with this convention. Backport of #114093 to `8.x`
1 parent 2f9f11a commit 645178f

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

docs/reference/snapshot-restore/repository-s3.asciidoc

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -311,20 +311,14 @@ include::repository-shared-settings.asciidoc[]
311311

312312
`delete_objects_max_size`::
313313

314-
(<<number,numeric>>) Sets the maxmimum batch size, betewen 1 and 1000, used
315-
for `DeleteObjects` requests. Defaults to 1000 which is the maximum number
316-
supported by the
317-
https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html[AWS
318-
DeleteObjects API].
314+
(integer) Sets the maxmimum batch size, betewen 1 and 1000, used for `DeleteObjects` requests. Defaults to 1000 which is the maximum
315+
number supported by the https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html[AWS DeleteObjects API].
319316

320317
`max_multipart_upload_cleanup_size`::
321318

322-
(<<number,numeric>>) Sets the maximum number of possibly-dangling multipart
323-
uploads to clean up in each batch of snapshot deletions. Defaults to `1000`
324-
which is the maximum number supported by the
325-
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html[AWS
326-
ListMultipartUploads API]. If set to `0`, {es} will not attempt to clean up
327-
dangling multipart uploads.
319+
(integer) Sets the maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions. Defaults to
320+
`1000` which is the maximum number supported by the https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html[AWS
321+
ListMultipartUploads API]. If set to `0`, {es} will not attempt to clean up dangling multipart uploads.
328322

329323
NOTE: The option of defining client settings in the repository settings as
330324
documented below is considered deprecated, and will be removed in a future

0 commit comments

Comments
 (0)