doc/rgw: document CreateBucketConfiguration for s3 PUT Bucket api

Fixes: http://tracker.ceph.com/issues/39597 Signed-off-by: Casey Bodley <cbodley@redhat.com> (cherry picked from commit e97668b)
ceph · Jun 12, 2019 · 635f0c5 · 635f0c5
1 parent d968e15
commit 635f0c5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/doc/radosgw/placement.rst b/doc/radosgw/placement.rst
@@ -195,6 +195,8 @@ format must be edited manually:
   $ vi user.json
   $ radosgw-admin metadata put user:<user-id> < user.json
 
+.. _s3_bucket_placement:
+
 S3 Bucket Placement
 -------------------
 

diff --git a/doc/radosgw/s3/bucketops.rst b/doc/radosgw/s3/bucketops.rst
@@ -7,8 +7,6 @@ PUT Bucket
 Creates a new bucket. To create a bucket, you must have a user ID and a valid AWS Access Key ID to authenticate requests. You may not
 create buckets as an anonymous user.
 
-.. note:: We do not support request entities for ``PUT /{bucket}`` in this release.
-
 Constraints
 ~~~~~~~~~~~
 In general, bucket names should follow domain name constraints.
@@ -37,6 +35,16 @@ Parameters
 | ``x-amz-acl`` | Canned ACLs.         | ``private``, ``public-read``, ``public-read-write``, ``authenticated-read`` | No         |
 +---------------+----------------------+-----------------------------------------------------------------------------+------------+
 
+Request Entities
+~~~~~~~~~~~~~~~~
+
++-------------------------------+-----------+----------------------------------------------------------------+
+| Name                          | Type      | Description                                                    |
++===============================+===========+================================================================+
+| ``CreateBucketConfiguration`` | Container | A container for the bucket configuration.                      |
++-------------------------------+-----------+----------------------------------------------------------------+
+| ``LocationConstraint``        | String    | A zonegroup api name, with optional :ref:`s3_bucket_placement` |
++-------------------------------+-----------+----------------------------------------------------------------+
 
 
 HTTP Response