From a5398f334a94b0a9d1ba6b766f20a050c16ee166 Mon Sep 17 00:00:00 2001 From: Tobias Urdin Date: Fri, 11 Apr 2025 10:37:45 +0200 Subject: [PATCH] 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 (cherry picked from commit 7fa025e08a21b03ce91556ffb936b9f26ffdc00f) --- doc/radosgw/adminops.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/doc/radosgw/adminops.rst b/doc/radosgw/adminops.rst index 2a0010d1ddc..1c643fea8d9 100644 --- a/doc/radosgw/adminops.rst +++ b/doc/radosgw/adminops.rst @@ -1319,6 +1319,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 @@ -1354,6 +1358,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 ~~~~~~~~~~~~~~~~~ @@ -1418,6 +1436,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 ~~~~~~~~~~~~~~~~~~~~~~~ -- 2.39.5