JAMES-2349 Adding quota details as part of the user quota documentation
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/9ceb7a0b Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/9ceb7a0b Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/9ceb7a0b Branch: refs/heads/master Commit: 9ceb7a0bc4b367ded13af22a3c84fcd97bb87944 Parents: 0062f1f Author: benwa <[email protected]> Authored: Wed Mar 14 10:39:28 2018 +0700 Committer: benwa <[email protected]> Committed: Thu Mar 15 15:55:43 2018 +0700 ---------------------------------------------------------------------- src/site/markdown/server/manage-webadmin.md | 28 +++++++++++++++++++----- 1 file changed, 22 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/9ceb7a0b/src/site/markdown/server/manage-webadmin.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md index d3ad7fe..21b8398 100644 --- a/src/site/markdown/server/manage-webadmin.md +++ b/src/site/markdown/server/manage-webadmin.md @@ -238,7 +238,23 @@ curl -XGET http://ip:port/quota/users/usernameToBeUsed Resource name usernameToBeUsed should be an existing user -The answer can contain a fixed value, an empty value (null) or an unlimited value (-1): +The answer is the details of the quota of that user. + +``` +{ + "global": {"count":252,"size":242}, + "domain": {"count":152,"size":142}, + "user": {"count":52,"size":42}, + "computed": {"count":52,"size":42} +} +``` + + - The `global` entry represent the quota limit allowed on this James server. + - The `domain` entry represent the quota limit allowed for the user of that domain. + - The `user` entry represent the quota limit allowed for this specific user. + - The `computed` entry represent the quota limit applied for this user, resolved from the upper values. + +Note that `quota` object can contain a fixed value, an empty value (null) or an unlimited value (-1): ``` {"count":52,"size":42} @@ -275,7 +291,7 @@ The body can contain a fixed value, an empty value (null) or an unlimited value Response codes: - 204: The quota has been updated - - 400: The body is not a positive integer or not unlimited value (-1). + - 400: The body is not a positive integer neither an unlimited value (-1). - 404: The user does not exist - 409: The requested restriction canât be enforced right now. - 500: Internal server error - Something went bad on the server side. @@ -317,7 +333,7 @@ The body can contain a fixed value or an unlimited value (-1): Response codes: - 204: The quota has been updated - - 400: The body is not a positive integer or not unlimited value (-1). + - 400: The body is not a positive integer neither an unlimited value (-1). - 404: The user does not exist - 409: The requested restriction canât be enforced right now. - 500: Internal server error - Something went bad on the server side. @@ -333,7 +349,7 @@ Resource name usernameToBeUsed should be an existing user Response codes: - 204: The quota has been updated to unlimited value. - - 400: The body is not a positive integer or not unlimited value (-1). + - 400: The body is not a positive integer neither an unlimited value (-1). - 404: The user does not exist - 409: The requested restriction canât be enforced right now. - 500: Internal server error - Something went bad on the server side. @@ -375,7 +391,7 @@ The body can contain a fixed value or an unlimited value (-1): Response codes: - 204: The quota has been updated - - 400: The body is not a positive integer or not unlimited value (-1). + - 400: The body is not a positive integer neither an unlimited value (-1). - 404: The user does not exist - 409: The requested restriction canât be enforced right now. - 500: Internal server error - Something went bad on the server side. @@ -391,7 +407,7 @@ Resource name usernameToBeUsed should be an existing user Response codes: - 204: The quota has been updated to unlimited value. - - 400: The body is not a positive integer or not unlimited value (-1). + - 400: The body is not a positive integer neither an unlimited value (-1). - 404: The user does not exist - 409: The requested restriction canât be enforced right now. - 500: Internal server error - Something went bad on the server side. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
