[james-project] 04/08: JAMES-3184 Update documentation

[bt...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit d9cfdbfcfbd9807f8b02f0d2aca5fddb1dc6230d
Author: LanKhuat <kh...@gmail.com>
AuthorDate: Wed May 20 11:56:58 2020 +0700

    JAMES-3184 Update documentation
---
 src/site/markdown/server/manage-webadmin.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md
index 28332ec..884ddc5 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -750,6 +750,18 @@ The message is UNSEEN via IMAP
 
 [More details about endpoints returning a task](#Endpoints_returning_a_task).
 
+An admin can specify the concurrency that should be used when running the task:
+
+ - `messagesPerSecond` rate of messages to be processed per second. Default is 100.
+
+This optional parameter must have a strictly positive integer as a value and be passed as query parameter.
+
+Example:
+
+```
+curl -XPOST /messages?task=SolveInconsistencies&messagesPerSecond=200
+```
+
 Response codes:
 
  - 201: Success. Corresponding task id is returned.
@@ -766,6 +778,9 @@ The scheduled task will have the following type `solve-message-inconsistencies`
   "addedMessageIdEntries": 1,
   "updatedMessageIdEntries": 0,
   "removedMessageIdEntries": 1,
+  "runningOptions":{
+    "messagesPerSecond": 200
+  },
   "fixedInconsistencies": [
     {
       "mailboxId": "551f0580-82fb-11ea-970e-f9c83d4cf8c2",


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org