Skip to content

Commit 8e80e00

Browse files
committed
doc/radosgw/adminops.rst: edit account documentation
This commit addresses PR comments related to the doc/radosgw/adminops documentation Signed-off-by: Nicholas Liu <[email protected]>
1 parent 78c55d6 commit 8e80e00

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

doc/radosgw/adminops.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ Special Error Responses
373373
None.
374374

375375
Create Account
376-
===========
376+
==============
377377
.. versionadded:: Squid
378378

379379
Create a new account.
@@ -400,7 +400,7 @@ Request Parameters
400400
:Example: ``RGW00000000000000001``
401401
:Required: Yes
402402

403-
An account ID must be 20 bytes long.
403+
An account ID must be 20 characters long, and in the format of the string "RGW" followed by 17 numeric characters.
404404

405405
``name``
406406

@@ -425,35 +425,35 @@ An account ID must be 20 bytes long.
425425

426426
``max-users``
427427

428-
:Description: Specifies the maximum number of users the account can own.
428+
:Description: Specifies the maximum number of users the account can own. The default is 1000.
429429
:Type: Integer
430430
:Example: 500 [1000]
431431
:Required: No
432432

433433
``max-roles``
434434

435-
:Description: Specifies the maximum number of roles the account can own.
435+
:Description: Specifies the maximum number of roles the account can own. The default is 1000.
436436
:Type: Integer
437437
:Example: 500 [1000]
438438
:Required: No
439439

440440
``max-groups``
441441

442-
:Description: Specifies the maximum number of groups the account can own.
442+
:Description: Specifies the maximum number of groups the account can own. The default is 1000.
443443
:Type: Integer
444444
:Example: 500 [1000]
445445
:Required: No
446446

447447
``max-access-keys``
448448

449-
:Description: Specifies the maximum number of access keys the account can own.
449+
:Description: Specifies the maximum number of access keys the account can own. The default is 4.
450450
:Type: Integer
451451
:Example: 1 [4]
452452
:Required: No
453453

454454
``max-buckets``
455455

456-
:Description: Specifies the maximum number of buckets the account can own.
456+
:Description: Specifies the maximum number of buckets the account can own. The default is 1000.
457457
:Type: Integer
458458
:Example: 500 [1000]
459459
:Required: No
@@ -600,15 +600,15 @@ Special Error Responses
600600

601601
``AccountAlreadyExists``
602602

603-
:Description: Attempt to create existing account. This can happen if the Account ID or the email is already in use.
603+
:Description: Attempt to create existing account. This can happen if the account ID or the email is already in use.
604604
:Code: 409 Conflict
605605

606606

607607
Modify Account
608-
===========
608+
==============
609609
.. versionadded:: Squid
610610

611-
Modify a account. Either an "id", "name", or "email" needs to be provided.
611+
Modify an account. Either ``id``, ``name``, or ``email`` must be provided.
612612

613613
:caps: accounts=write
614614

@@ -647,35 +647,35 @@ Request Parameters
647647

648648
``max-users``
649649

650-
:Description: Specifies the maximum number of users the account can own.
650+
:Description: Specifies the maximum number of users the account can own. The default is 1000.
651651
:Type: Integer
652652
:Example: 500 [1000]
653653
:Required: No
654654

655655
``max-roles``
656656

657-
:Description: Specifies the maximum number of roles the account can own.
657+
:Description: Specifies the maximum number of roles the account can own. The default is 1000.
658658
:Type: Integer
659659
:Example: 500 [1000]
660660
:Required: No
661661

662662
``max-groups``
663663

664-
:Description: Specifies the maximum number of groups the account can own.
664+
:Description: Specifies the maximum number of groups the account can own. The default is 1000.
665665
:Type: Integer
666666
:Example: 500 [1000]
667667
:Required: No
668668

669669
``max-access-keys``
670670

671-
:Description: Specifies the maximum number of access keys the account can own.
671+
:Description: Specifies the maximum number of access keys the account can own. The default is 4.
672672
:Type: Integer
673673
:Example: 1 [4]
674674
:Required: No
675675

676676
``max-buckets``
677677

678-
:Description: Specifies the maximum number of buckets the account can own.
678+
:Description: Specifies the maximum number of buckets the account can own. The default is 1000.
679679
:Type: Integer
680680
:Example: 500 [1000]
681681
:Required: No
@@ -692,7 +692,7 @@ If successful, the response contains the following account information.
692692

693693
``id``
694694

695-
:Description: The account id.
695+
:Description: The account ID.
696696
:Type: String
697697
:Parent: ``account``
698698

@@ -826,7 +826,7 @@ Get Account Info
826826
===========
827827
.. versionadded:: Squid
828828

829-
Get account info. Either an "id" or a "name" needs to be provided.
829+
Get account info. Either an ``id`` or a ``name`` must be provided.
830830

831831
:caps: accounts=write
832832

@@ -869,7 +869,7 @@ If successful, the response contains the following account information.
869869

870870
``id``
871871

872-
:Description: The account id.
872+
:Description: The account ID.
873873
:Type: String
874874
:Parent: ``account``
875875

@@ -1000,10 +1000,10 @@ Special Error Responses
10001000
None.
10011001

10021002
Remove Account
1003-
===========
1003+
==============
10041004
.. versionadded:: Squid
10051005

1006-
Remove an existing account. Either an "id", "name", or "email" needs to be provided.
1006+
Remove an existing account. Either ``id``, ``name``, or ``email`` must be provided.
10071007

10081008
:caps: accounts=write
10091009

@@ -1189,7 +1189,7 @@ A tenant name may also specified as a part of ``uid``, by following the syntax
11891189

11901190
``account-id``
11911191

1192-
:Description: the Account under which a user should exist.
1192+
:Description: the account under which a user should exist.
11931193
:Type: string
11941194
:Example: RGW00000000000000001
11951195
:Required: No
@@ -2769,15 +2769,15 @@ as mentioned in Set Bucket Quota section above.
27692769

27702770

27712771
Set Account Quota
2772-
~~~~~~~~~~~~~~
2772+
~~~~~~~~~~~~~~~~~
27732773

27742774
To set a quota, the user must have ``accounts`` capability set with ``write``
27752775
permission. ::
27762776

27772777
PUT /admin/account?quota&id=<account_id>&quota-type=account
27782778

27792779
Set Bucket Quota under an Account
2780-
~~~~~~~~~~~~~~~~
2780+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27812781

27822782
To set a quota, the user must have ``accounts`` capability set with ``write``
27832783
permission. ::

0 commit comments

Comments
 (0)