From: Tobias Urdin <tobias.urdin@binero.com>
Date: Fri, 11 Apr 2025 08:37:45 +0000 (+0200)
Subject: rgw/doc: Add doc for admin bucket list pagination
X-Git-Tag: testing/wip-jcollin-testing-20250918.013120-squid~8^2~2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=77592b1886b00b83fce62ca7481ac9710e367dfc;p=ceph-ci.git

rgw/doc: Add doc for admin bucket list pagination

This adds the documentation for the admin bucket list
pagination change.

Signed-off-by: Tobias Urdin <tobias.urdin@binero.com>
(cherry picked from commit 7fa025e08a21b03ce91556ffb936b9f26ffdc00f)
---

diff --git a/doc/radosgw/adminops.rst b/doc/radosgw/adminops.rst
index 4b6ba3ec34d..8df184a8f6b 100644
--- a/doc/radosgw/adminops.rst
+++ b/doc/radosgw/adminops.rst
@@ -1293,6 +1293,10 @@ without ``bucket`` then all buckets belonging to the user will be returned. If
 ``bucket`` alone is specified, information for that particular bucket will be
 retrieved.
 
+If ``max-entries`` is specified to limit the number of buckets returned, the
+response body will change and contain the keys ``buckets``, ``count`` and
+``truncated``. If ``truncated`` is true the ``marker`` key will also be added.
+
 :caps: buckets=read
 
 Syntax
@@ -1328,6 +1332,20 @@ Request Parameters
 :Example: True [False]
 :Required: No
 
+``max-entries``
+
+:Description: The number of bucket list entries to return.
+:Type: Integer
+:Example: 100
+:Required: No
+
+``marker``
+
+:Description: The marker to use when listing buckets.
+:Type: String (bucket name)
+:Example: my-bucket
+:Required: No
+
 Response Entities
 ~~~~~~~~~~~~~~~~~
 
@@ -1392,6 +1410,22 @@ the desired bucket information.
 :Type: String
 :Parent: ``bucket``
 
+``count``
+
+:Description: Number of returned buckets, only if ``max-entries`` is specified.
+:Type: Integer
+
+``truncated``
+
+:Description: Reported if the response is truncated when ``max-entries`` is specified.
+:Type: Boolean
+
+``marker``
+
+:Description: If ``truncated`` is true the ``marker`` key is returned with
+              the marker (bucket name) to use to continue pagination.
+:Type: String
+
 Special Error Responses
 ~~~~~~~~~~~~~~~~~~~~~~~